From c72bd8ff5a7d6e5da9203cf0f37418df955435c2 Mon Sep 17 00:00:00 2001 From: Jamil Date: Wed, 29 Mar 2023 09:07:36 -0700 Subject: [PATCH] Fix docs typos (#1532) Fixes #1530 Fixes #1531 --- .../fz_http/lib/fz_http/config/definitions.ex | 4 +- www/docs/reference/env-vars.mdx | 4 +- .../reference/rest-api/configurations.mdx | 12 +- www/docs/reference/rest-api/devices.mdx | 134 +++++++++--------- www/docs/reference/rest-api/rules.mdx | 60 ++++---- www/docs/reference/rest-api/users.mdx | 90 ++++++------ .../reverse-proxy-templates/traefik.mdx | 10 +- 7 files changed, 157 insertions(+), 157 deletions(-) diff --git a/apps/fz_http/lib/fz_http/config/definitions.ex b/apps/fz_http/lib/fz_http/config/definitions.ex index 327587c0b..6a2872c76 100644 --- a/apps/fz_http/lib/fz_http/config/definitions.ex +++ b/apps/fz_http/lib/fz_http/config/definitions.ex @@ -367,7 +367,7 @@ defmodule FzHttp.Config.Definitions do ) @doc """ - Encryption salt for cookies issued by the Phoenix web application. + Signing salt for cookies issued by the Phoenix web application. """ defconfig(:cookie_signing_salt, :string, sensitive: true, @@ -375,7 +375,7 @@ defmodule FzHttp.Config.Definitions do ) @doc """ - Signing salt for cookies issued by the Phoenix web application. + Encryption salt for cookies issued by the Phoenix web application. """ defconfig(:cookie_encryption_salt, :string, sensitive: true, diff --git a/www/docs/reference/env-vars.mdx b/www/docs/reference/env-vars.mdx index ba530f6fc..3d7764c6f 100644 --- a/www/docs/reference/env-vars.mdx +++ b/www/docs/reference/env-vars.mdx @@ -82,8 +82,8 @@ All secrets should be a **base64-encoded string**. | **DATABASE_ENCRYPTION_KEY** | Secret key used for encrypting sensitive data in the database. | string | | | **SECRET_KEY_BASE** | Primary secret key base for the Phoenix application. | string | | | **LIVE_VIEW_SIGNING_SALT** | Signing salt for Phoenix LiveView connection tokens. | string | | -| **COOKIE_SIGNING_SALT** | Encryption salt for cookies issued by the Phoenix web application. | string | | -| **COOKIE_ENCRYPTION_SALT** | Signing salt for cookies issued by the Phoenix web application. | string | | +| **COOKIE_SIGNING_SALT** | Signing salt for cookies issued by the Phoenix web application. | string | | +| **COOKIE_ENCRYPTION_SALT** | Encryption salt for cookies issued by the Phoenix web application. | string | | ### Devices diff --git a/www/docs/reference/rest-api/configurations.mdx b/www/docs/reference/rest-api/configurations.mdx index 54a0b121a..20d7eae87 100644 --- a/www/docs/reference/rest-api/configurations.mdx +++ b/www/docs/reference/rest-api/configurations.mdx @@ -39,13 +39,13 @@ Content-Type: application/json; charset=utf-8 "default_client_mtu": 1280, "default_client_persistent_keepalive": 25, "disable_vpn_on_oidc_error": false, - "id": "9fe70a6b-8af7-46e3-88d2-050804edca94", - "inserted_at": "2023-02-21T19:41:56.505552Z", + "id": "c4582e2b-cba3-4a4e-9f05-0f37666c41fe", + "inserted_at": "2023-03-29T15:10:03.142320Z", "local_auth_enabled": true, "logo": {}, "openid_connect_providers": [], "saml_identity_providers": [], - "updated_at": "2023-02-21T19:41:56.505552Z", + "updated_at": "2023-03-29T15:10:03.142320Z", "vpn_session_duration": 0 } } @@ -126,8 +126,8 @@ Content-Type: application/json; charset=utf-8 "default_client_mtu": 1100, "default_client_persistent_keepalive": 1, "disable_vpn_on_oidc_error": true, - "id": "9fe70a6b-8af7-46e3-88d2-050804edca94", - "inserted_at": "2023-02-21T19:41:56.505552Z", + "id": "c4582e2b-cba3-4a4e-9f05-0f37666c41fe", + "inserted_at": "2023-03-29T15:10:03.142320Z", "local_auth_enabled": false, "logo": {}, "openid_connect_providers": [ @@ -156,7 +156,7 @@ Content-Type: application/json; charset=utf-8 "signed_envelopes_in_resp": false } ], - "updated_at": "2023-02-21T19:42:17.438639Z", + "updated_at": "2023-03-29T15:11:47.879874Z", "vpn_session_duration": 100 } } diff --git a/www/docs/reference/rest-api/devices.mdx b/www/docs/reference/rest-api/devices.mdx index 02478f37c..4fdcdf3ac 100644 --- a/www/docs/reference/rest-api/devices.mdx +++ b/www/docs/reference/rest-api/devices.mdx @@ -34,27 +34,27 @@ Content-Type: application/json; charset=utf-8 "1.0.0.1" ], "endpoint": "localhost:51820", - "id": "2b6c28a8-ca1b-4ecc-8133-b3d6619d47af", - "inserted_at": "2023-02-21T19:42:16.612776Z", - "ipv4": "100.93.194.179", - "ipv6": "fd00::22:71ab", + "id": "61d5930b-2b35-44b3-87a9-904e81806728", + "inserted_at": "2023-03-29T15:11:47.450107Z", + "ipv4": "100.72.98.240", + "ipv6": "fd00::39:bf15", "latest_handshake": null, "mtu": 1280, - "name": "factory 4135", + "name": "factory 4421", "persistent_keepalive": 25, - "preshared_key": "r8nGfWLQWzp2AyCKMfVfrU9AzNtCbcExQt/Xv15UnPA=", - "public_key": "qNBDIg99AQV5Zr3I3gOtCjBpf+8y5g1wft8r55ZPCSg=", + "preshared_key": "32vztut9u6QJG2spTUMnvcb+twugGlT1ikM6AyiPDv8=", + "public_key": "cGEIZje2ITjFDn96F3bItc5BCl8G1r4SWHH/6QUF4ek=", "remote_ip": null, "rx_bytes": null, "server_public_key": "is+0ov0/SZ9I+qyDD+adVoH9LreWHa85QQgpt6RUtA4=", "tx_bytes": null, - "updated_at": "2023-02-21T19:42:16.612776Z", + "updated_at": "2023-03-29T15:11:47.450107Z", "use_default_allowed_ips": true, "use_default_dns": true, "use_default_endpoint": true, "use_default_mtu": true, "use_default_persistent_keepalive": true, - "user_id": "7c69c4a8-e335-40e0-b946-088a793873a9" + "user_id": "56062619-2fe2-49de-898c-492d8da794c7" }, { "allowed_ips": [ @@ -67,27 +67,27 @@ Content-Type: application/json; charset=utf-8 "1.0.0.1" ], "endpoint": "localhost:51820", - "id": "c570ecf3-bf90-449e-9396-e11f3f5e1c3c", - "inserted_at": "2023-02-21T19:42:16.619638Z", - "ipv4": "100.66.157.239", - "ipv6": "fd00::1a:8b94", + "id": "05db5d62-218e-4139-92f5-0510903ce4f8", + "inserted_at": "2023-03-29T15:11:47.455712Z", + "ipv4": "100.111.252.39", + "ipv6": "fd00::2:456a", "latest_handshake": null, "mtu": 1280, - "name": "factory 3428", + "name": "factory 5411", "persistent_keepalive": 25, - "preshared_key": "iPVrNTAmZIaptYD9kqgDSy3etX02PrKP2xDEwaU0CTk=", - "public_key": "5XHK3GYXPD5/rqND52mgYL9VjY64M1O/0xtl3w21p+E=", + "preshared_key": "78O12m5lG+je3eAqlgJ9pd6d/+VeLjsswsljJFV0jU0=", + "public_key": "ADOmUjeMl08RgKNhpRaaaHV3YmI9GOVh81zLVLOPk84=", "remote_ip": null, "rx_bytes": null, "server_public_key": "is+0ov0/SZ9I+qyDD+adVoH9LreWHa85QQgpt6RUtA4=", "tx_bytes": null, - "updated_at": "2023-02-21T19:42:16.619638Z", + "updated_at": "2023-03-29T15:11:47.455712Z", "use_default_allowed_ips": true, "use_default_dns": true, "use_default_endpoint": true, "use_default_mtu": true, "use_default_persistent_keepalive": true, - "user_id": "3c5c32d8-913c-44ca-9211-9c401dffc0ee" + "user_id": "9d3e2da3-bce1-4a03-95cc-d8d0a9797a17" }, { "allowed_ips": [ @@ -100,27 +100,27 @@ Content-Type: application/json; charset=utf-8 "1.0.0.1" ], "endpoint": "localhost:51820", - "id": "d07e42e0-205c-495b-bee7-bbd29a7cb22c", - "inserted_at": "2023-02-21T19:42:16.625365Z", - "ipv4": "100.98.252.135", - "ipv6": "fd00::33:7a15", + "id": "c865c545-36bd-473e-9c20-9b76766582b2", + "inserted_at": "2023-03-29T15:11:47.461266Z", + "ipv4": "100.116.252.229", + "ipv6": "fd00::7:f039", "latest_handshake": null, "mtu": 1280, - "name": "factory 5186", + "name": "factory 5766", "persistent_keepalive": 25, - "preshared_key": "PwcToalzmZ+aDXT7HDDOC+YsK+HzSdw8pX/e9FtdUQ4=", - "public_key": "LrWe6VAmNrI4lU2GtlS8W//U3lEu5LmnpXzEAPgu2K0=", + "preshared_key": "Dlefj06JAOOCtKxoSlLmvmNXq2zql30FvwDFlEpEISQ=", + "public_key": "hH9ifN5kI1RtnG54eUXGLEL7Pue9qgGvJ3Gvef7irzU=", "remote_ip": null, "rx_bytes": null, "server_public_key": "is+0ov0/SZ9I+qyDD+adVoH9LreWHa85QQgpt6RUtA4=", "tx_bytes": null, - "updated_at": "2023-02-21T19:42:16.625365Z", + "updated_at": "2023-03-29T15:11:47.461266Z", "use_default_allowed_ips": true, "use_default_dns": true, "use_default_endpoint": true, "use_default_mtu": true, "use_default_persistent_keepalive": true, - "user_id": "0e67b63f-0c4d-499f-9c82-aeb8e15d46c1" + "user_id": "47a8eda4-433a-4ce3-a119-720b5d62ddac" }, { "allowed_ips": [ @@ -133,27 +133,27 @@ Content-Type: application/json; charset=utf-8 "1.0.0.1" ], "endpoint": "localhost:51820", - "id": "73e897da-7e96-4839-a1b3-3c22b517cd87", - "inserted_at": "2023-02-21T19:42:16.630393Z", - "ipv4": "100.127.77.200", - "ipv6": "fd00::13:a5da", + "id": "93da8405-217e-40b3-a91b-45d8cd28c2d4", + "inserted_at": "2023-03-29T15:11:47.467794Z", + "ipv4": "100.70.183.42", + "ipv6": "fd00::9:a393", "latest_handshake": null, "mtu": 1280, - "name": "factory 5250", + "name": "factory 1417", "persistent_keepalive": 25, - "preshared_key": "p0ZePh6jGs2cnxhampSudq/qyWDTqZUvAmuDuQzIhg8=", - "public_key": "Xi4k6cp5bWF3it3sHKlu7/Pc4PQ/0CNhFDC/4e1QJ8c=", + "preshared_key": "3ipinU20+iTgqCZxSskRPRTBargqtoG73seKz8wZqiE=", + "public_key": "gzAOiYTnq+rFRBDUbRuJhKXCbe+ULB9xjpCy9l0mBCA=", "remote_ip": null, "rx_bytes": null, "server_public_key": "is+0ov0/SZ9I+qyDD+adVoH9LreWHa85QQgpt6RUtA4=", "tx_bytes": null, - "updated_at": "2023-02-21T19:42:16.630393Z", + "updated_at": "2023-03-29T15:11:47.467794Z", "use_default_allowed_ips": true, "use_default_dns": true, "use_default_endpoint": true, "use_default_mtu": true, "use_default_persistent_keepalive": true, - "user_id": "219cc61b-a9fc-40f6-960c-9dc49b6a9285" + "user_id": "d8c001ca-ee0f-457f-80a6-802592a7d4ca" }, { "allowed_ips": [ @@ -166,27 +166,27 @@ Content-Type: application/json; charset=utf-8 "1.0.0.1" ], "endpoint": "localhost:51820", - "id": "0264a1e7-d856-427a-bdab-56b27dad953e", - "inserted_at": "2023-02-21T19:42:16.635042Z", - "ipv4": "100.82.95.202", - "ipv6": "fd00::8:ee28", + "id": "16b319c1-4d8a-478a-88d2-f17056bf1b66", + "inserted_at": "2023-03-29T15:11:47.473062Z", + "ipv4": "100.101.38.171", + "ipv6": "fd00::39:35af", "latest_handshake": null, "mtu": 1280, - "name": "factory 3493", + "name": "factory 4485", "persistent_keepalive": 25, - "preshared_key": "LG/iIPIUfoGcXSCSYuw+DGJVYJkdwjNtqZCzvIgGsWw=", - "public_key": "Ypxx0s+69Zrcrm9V+EpXDSOnZ2vhYfeVaKL6ayZ+xWA=", + "preshared_key": "WzNqj8NEQBvYCYjWv4qhuL8sT3n0LVIH52x1xx5U6EE=", + "public_key": "eD1iqgs712xDZsplZHd7LrNs+WXYshMH99WFkJ0So8o=", "remote_ip": null, "rx_bytes": null, "server_public_key": "is+0ov0/SZ9I+qyDD+adVoH9LreWHa85QQgpt6RUtA4=", "tx_bytes": null, - "updated_at": "2023-02-21T19:42:16.635042Z", + "updated_at": "2023-03-29T15:11:47.473062Z", "use_default_allowed_ips": true, "use_default_dns": true, "use_default_endpoint": true, "use_default_mtu": true, "use_default_persistent_keepalive": true, - "user_id": "f60df8f7-9274-49a4-a5d3-9c772b7e81bb" + "user_id": "605c4532-d516-4b59-a7df-b0479d493cce" } ] } @@ -226,14 +226,14 @@ $ curl -i \ "use_default_endpoint": false, "use_default_mtu": false, "use_default_persistent_keepalive": false, - "user_id": "037f7617-93f1-4f7b-b8d5-db0512a7de10" + "user_id": "95138a8e-c89f-41b4-b62c-a5b8c23a0b8c" } }' EOF HTTP/1.1 201 Content-Type: application/json; charset=utf-8 -Location: /v0/devices/fe5e53fd-faac-4436-9e6e-76c00d2e7f47 +Location: /v0/devices/3aefe1b8-d98b-4725-bed3-cad021a13480 { "data": { @@ -247,8 +247,8 @@ Location: /v0/devices/fe5e53fd-faac-4436-9e6e-76c00d2e7f47 "9.9.9.8" ], "endpoint": "9.9.9.9", - "id": "fe5e53fd-faac-4436-9e6e-76c00d2e7f47", - "inserted_at": "2023-02-21T19:42:16.821122Z", + "id": "3aefe1b8-d98b-4725-bed3-cad021a13480", + "inserted_at": "2023-03-29T15:11:47.190722Z", "ipv4": "100.64.0.2", "ipv6": "fd00::2", "latest_handshake": null, @@ -261,13 +261,13 @@ Location: /v0/devices/fe5e53fd-faac-4436-9e6e-76c00d2e7f47 "rx_bytes": null, "server_public_key": "is+0ov0/SZ9I+qyDD+adVoH9LreWHa85QQgpt6RUtA4=", "tx_bytes": null, - "updated_at": "2023-02-21T19:42:16.821122Z", + "updated_at": "2023-03-29T15:11:47.190722Z", "use_default_allowed_ips": false, "use_default_dns": false, "use_default_endpoint": false, "use_default_mtu": false, "use_default_persistent_keepalive": false, - "user_id": "037f7617-93f1-4f7b-b8d5-db0512a7de10" + "user_id": "95138a8e-c89f-41b4-b62c-a5b8c23a0b8c" } } ``` @@ -278,7 +278,7 @@ Location: /v0/devices/fe5e53fd-faac-4436-9e6e-76c00d2e7f47 #### Example **URI Parameters:** - - `id`: `a8ede14d-7ffd-42b1-a0c4-28d4aa5d0749` + - `id`: `f85310b7-87b5-4c89-b391-d985f7789007` ```bash $ curl -i \ -X GET "https://{firezone_host}/v0/devices/{id}" \ @@ -300,27 +300,27 @@ Content-Type: application/json; charset=utf-8 "1.0.0.1" ], "endpoint": "localhost:51820", - "id": "a8ede14d-7ffd-42b1-a0c4-28d4aa5d0749", - "inserted_at": "2023-02-21T19:42:16.861814Z", - "ipv4": "100.67.104.45", - "ipv6": "fd00::30:dad3", + "id": "f85310b7-87b5-4c89-b391-d985f7789007", + "inserted_at": "2023-03-29T15:11:47.299345Z", + "ipv4": "100.99.173.193", + "ipv6": "fd00::17:d1a9", "latest_handshake": null, "mtu": 1280, - "name": "factory 4581", + "name": "factory 713", "persistent_keepalive": 25, - "preshared_key": "G1UmGBirIP2XiBOVb0OcKnLjvhNQrUXq5WcwpYozzsc=", - "public_key": "dDRr56ECg6sLBKT4+wDVkkL6JhzcmI+jOfgbp1NBydY=", + "preshared_key": "qrcrAnUh7ryP69SwfseKdBNElOSjOC9/Wv7Z+EBxs50=", + "public_key": "mLN9py6whsGt+Lg9jP4lX+Cqqlf02plODqWg2UqOmPI=", "remote_ip": null, "rx_bytes": null, "server_public_key": "is+0ov0/SZ9I+qyDD+adVoH9LreWHa85QQgpt6RUtA4=", "tx_bytes": null, - "updated_at": "2023-02-21T19:42:16.861814Z", + "updated_at": "2023-03-29T15:11:47.299345Z", "use_default_allowed_ips": true, "use_default_dns": true, "use_default_endpoint": true, "use_default_mtu": true, "use_default_persistent_keepalive": true, - "user_id": "a7182e3d-be17-4833-9669-c0efe861541a" + "user_id": "5f5b582d-9153-46ac-99e5-37a6bc93ce13" } } ``` @@ -331,7 +331,7 @@ Content-Type: application/json; charset=utf-8 #### Example **URI Parameters:** - - `id`: `d87aae90-e4b2-4e2b-92c2-728f02053745` + - `id`: `01272ce2-df59-4816-9d82-44830427d757` ```bash $ curl -i \ -X PUT "https://{firezone_host}/v0/devices/{id}" \ @@ -381,8 +381,8 @@ Content-Type: application/json; charset=utf-8 "9.9.9.8" ], "endpoint": "9.9.9.9", - "id": "d87aae90-e4b2-4e2b-92c2-728f02053745", - "inserted_at": "2023-02-21T19:42:16.734558Z", + "id": "01272ce2-df59-4816-9d82-44830427d757", + "inserted_at": "2023-03-29T15:11:47.264313Z", "ipv4": "100.64.0.2", "ipv6": "fd00::2", "latest_handshake": null, @@ -395,13 +395,13 @@ Content-Type: application/json; charset=utf-8 "rx_bytes": null, "server_public_key": "is+0ov0/SZ9I+qyDD+adVoH9LreWHa85QQgpt6RUtA4=", "tx_bytes": null, - "updated_at": "2023-02-21T19:42:16.744067Z", + "updated_at": "2023-03-29T15:11:47.276849Z", "use_default_allowed_ips": false, "use_default_dns": false, "use_default_endpoint": false, "use_default_mtu": false, "use_default_persistent_keepalive": false, - "user_id": "e3199f2c-8bf1-4371-8217-b7277bfedae6" + "user_id": "3f7c9d0f-fa89-4619-9237-f0215db34e58" } } ``` @@ -412,7 +412,7 @@ Content-Type: application/json; charset=utf-8 #### Example **URI Parameters:** - - `id`: `8a7e0c57-7e12-433c-8a6c-151359c5b3e3` + - `id`: `29f86ac9-82e8-4691-aa44-ea396d3af476` ```bash $ curl -i \ -X DELETE "https://{firezone_host}/v0/devices/{id}" \ diff --git a/www/docs/reference/rest-api/rules.mdx b/www/docs/reference/rest-api/rules.mdx index c4f1c5694..a2ce1ad28 100644 --- a/www/docs/reference/rest-api/rules.mdx +++ b/www/docs/reference/rest-api/rules.mdx @@ -26,51 +26,51 @@ Content-Type: application/json; charset=utf-8 { "action": "drop", "destination": "10.3.2.1", - "id": "db5a18ef-a033-48fb-a318-af054c8d3ace", - "inserted_at": "2023-02-21T19:42:16.822620Z", + "id": "2a136a17-4d29-4d8b-a6d4-f35ee3051105", + "inserted_at": "2023-03-29T15:11:47.482818Z", "port_range": null, "port_type": null, - "updated_at": "2023-02-21T19:42:16.822620Z", + "updated_at": "2023-03-29T15:11:47.482818Z", "user_id": null }, { "action": "drop", "destination": "10.3.2.2", - "id": "2b02c33b-4589-4912-bf38-44bc3853a611", - "inserted_at": "2023-02-21T19:42:16.824085Z", + "id": "7a4961bf-6b2b-4217-b87b-ffd1deb448ac", + "inserted_at": "2023-03-29T15:11:47.483506Z", "port_range": null, "port_type": null, - "updated_at": "2023-02-21T19:42:16.824085Z", + "updated_at": "2023-03-29T15:11:47.483506Z", "user_id": null }, { "action": "drop", "destination": "10.3.2.3", - "id": "2b93d655-f870-4c2e-942d-529234f58289", - "inserted_at": "2023-02-21T19:42:16.825104Z", + "id": "6dffbc74-ec58-43ca-8700-d0c572baa198", + "inserted_at": "2023-03-29T15:11:47.484107Z", "port_range": null, "port_type": null, - "updated_at": "2023-02-21T19:42:16.825104Z", + "updated_at": "2023-03-29T15:11:47.484107Z", "user_id": null }, { "action": "drop", "destination": "10.3.2.4", - "id": "fb74d75b-6ce3-420b-9d15-532832110c58", - "inserted_at": "2023-02-21T19:42:16.826185Z", + "id": "9bba129d-cdad-4efe-8296-b78ba50f3ef4", + "inserted_at": "2023-03-29T15:11:47.484759Z", "port_range": null, "port_type": null, - "updated_at": "2023-02-21T19:42:16.826185Z", + "updated_at": "2023-03-29T15:11:47.484759Z", "user_id": null }, { "action": "drop", "destination": "10.3.2.5", - "id": "392cee84-07ef-4ecd-9c9f-b916e2aff155", - "inserted_at": "2023-02-21T19:42:16.827016Z", + "id": "df142fde-922c-4a6d-a8e4-0b145a875624", + "inserted_at": "2023-03-29T15:11:47.485540Z", "port_range": null, "port_type": null, - "updated_at": "2023-02-21T19:42:16.827016Z", + "updated_at": "2023-03-29T15:11:47.485540Z", "user_id": null } ] @@ -93,25 +93,25 @@ $ curl -i \ "destination": "1.1.1.1/24", "port_range": "1 - 2", "port_type": "udp", - "user_id": "a80e866c-bee5-4dfd-adc0-3847b67b9d56" + "user_id": "def4dacc-6367-4320-a0fb-4675b9b571cf" } }' EOF HTTP/1.1 201 Content-Type: application/json; charset=utf-8 -Location: /v0/rules/c9a8a01e-d852-49c0-bcdb-5ea5f70ad932 +Location: /v0/rules/c52efbe6-5ed0-4514-97df-93f6013dd52b { "data": { "action": "accept", "destination": "1.1.1.1/24", - "id": "c9a8a01e-d852-49c0-bcdb-5ea5f70ad932", - "inserted_at": "2023-02-21T19:42:16.853089Z", + "id": "c52efbe6-5ed0-4514-97df-93f6013dd52b", + "inserted_at": "2023-03-29T15:11:47.185000Z", "port_range": "1 - 2", "port_type": "udp", - "updated_at": "2023-02-21T19:42:16.853089Z", - "user_id": "a80e866c-bee5-4dfd-adc0-3847b67b9d56" + "updated_at": "2023-03-29T15:11:47.185000Z", + "user_id": "def4dacc-6367-4320-a0fb-4675b9b571cf" } } ``` @@ -122,7 +122,7 @@ Location: /v0/rules/c9a8a01e-d852-49c0-bcdb-5ea5f70ad932 #### Example **URI Parameters:** - - `id`: `cf77ba9e-604d-408d-a444-4fcee57662d3` + - `id`: `dd39b339-2ac4-4c83-96e5-9b29516dd85e` ```bash $ curl -i \ -X GET "https://{firezone_host}/v0/rules/{id}" \ @@ -136,11 +136,11 @@ Content-Type: application/json; charset=utf-8 "data": { "action": "drop", "destination": "10.10.10.0/24", - "id": "cf77ba9e-604d-408d-a444-4fcee57662d3", - "inserted_at": "2023-02-21T19:42:16.881405Z", + "id": "dd39b339-2ac4-4c83-96e5-9b29516dd85e", + "inserted_at": "2023-03-29T15:11:47.447659Z", "port_range": null, "port_type": null, - "updated_at": "2023-02-21T19:42:16.881405Z", + "updated_at": "2023-03-29T15:11:47.447659Z", "user_id": null } } @@ -152,7 +152,7 @@ Content-Type: application/json; charset=utf-8 #### Example **URI Parameters:** - - `id`: `21275ade-d14e-4421-8cdf-49bca4d84d63` + - `id`: `720fdab6-32af-4487-bce5-e72fa76be829` ```bash $ curl -i \ -X PUT "https://{firezone_host}/v0/rules/{id}" \ @@ -176,11 +176,11 @@ Content-Type: application/json; charset=utf-8 "data": { "action": "accept", "destination": "1.1.1.1/24", - "id": "21275ade-d14e-4421-8cdf-49bca4d84d63", - "inserted_at": "2023-02-21T19:42:16.786969Z", + "id": "720fdab6-32af-4487-bce5-e72fa76be829", + "inserted_at": "2023-03-29T15:11:47.243306Z", "port_range": "1 - 2", "port_type": "udp", - "updated_at": "2023-02-21T19:42:16.795630Z", + "updated_at": "2023-03-29T15:11:47.251589Z", "user_id": null } } @@ -192,7 +192,7 @@ Content-Type: application/json; charset=utf-8 #### Example **URI Parameters:** - - `id`: `526b66e7-6433-4607-af87-9046a3c801e9` + - `id`: `f5f10a6e-cfdd-47ea-ae23-264195b3503c` ```bash $ curl -i \ -X DELETE "https://{firezone_host}/v0/rules/{id}" \ diff --git a/www/docs/reference/rest-api/users.mdx b/www/docs/reference/rest-api/users.mdx index 36cb691cd..80ecaee9d 100644 --- a/www/docs/reference/rest-api/users.mdx +++ b/www/docs/reference/rest-api/users.mdx @@ -40,43 +40,43 @@ Content-Type: application/json; charset=utf-8 "data": [ { "disabled_at": null, - "email": "test-8357@test", - "id": "97b501a3-3d19-4755-9355-e69e8343e3fe", - "inserted_at": "2023-02-21T19:42:17.788005Z", + "email": "test-5094@test", + "id": "4963a5f0-dbb5-424a-8859-8032209eeaef", + "inserted_at": "2023-03-29T15:11:47.363517Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "admin", - "updated_at": "2023-02-21T19:42:17.788005Z" + "updated_at": "2023-03-29T15:11:47.363517Z" }, { "disabled_at": null, - "email": "test-8389@test", - "id": "95de026c-85cb-437f-9f65-7598eecd2500", - "inserted_at": "2023-02-21T19:42:17.789353Z", + "email": "test-5634@test", + "id": "e904d9ae-c358-4ab4-9bfd-44b4bf942a15", + "inserted_at": "2023-03-29T15:11:47.364938Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "admin", - "updated_at": "2023-02-21T19:42:17.789353Z" + "updated_at": "2023-03-29T15:11:47.364938Z" }, { "disabled_at": null, - "email": "test-8421@test", - "id": "7318786c-00ef-4cb1-afde-5a36698abc5a", - "inserted_at": "2023-02-21T19:42:17.791365Z", + "email": "test-5666@test", + "id": "e7decf88-4abb-45df-9dd0-35e3587dfb59", + "inserted_at": "2023-03-29T15:11:47.366068Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "admin", - "updated_at": "2023-02-21T19:42:17.791365Z" + "updated_at": "2023-03-29T15:11:47.366068Z" }, { "disabled_at": null, - "email": "test-8453@test", - "id": "c930b715-b9f6-40af-970a-cf02da7d7f89", - "inserted_at": "2023-02-21T19:42:17.792835Z", + "email": "test-5190@test", + "id": "457aeee0-13aa-44b3-9057-181cc206edcb", + "inserted_at": "2023-03-29T15:11:47.367568Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "admin", - "updated_at": "2023-02-21T19:42:17.792835Z" + "updated_at": "2023-03-29T15:11:47.367568Z" } ] } @@ -126,18 +126,18 @@ EOF HTTP/1.1 201 Content-Type: application/json; charset=utf-8 -Location: /v0/users/98a7f35a-b517-44fb-8381-9ca84d9adebb +Location: /v0/users/2b7128fb-4a30-472d-9f45-d2a5063ba5db { "data": { "disabled_at": null, "email": "new-user@test", - "id": "98a7f35a-b517-44fb-8381-9ca84d9adebb", - "inserted_at": "2023-02-21T19:42:17.682511Z", + "id": "2b7128fb-4a30-472d-9f45-d2a5063ba5db", + "inserted_at": "2023-03-29T15:11:47.178709Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "unprivileged", - "updated_at": "2023-02-21T19:42:17.682511Z" + "updated_at": "2023-03-29T15:11:47.178709Z" } } ``` @@ -158,18 +158,18 @@ EOF HTTP/1.1 201 Content-Type: application/json; charset=utf-8 -Location: /v0/users/ccd53707-1edf-4a4f-b4e8-26aa6ef9adec +Location: /v0/users/e4796108-f4d8-4a11-9860-d07b92b08d93 { "data": { "disabled_at": null, "email": "new-user@test", - "id": "ccd53707-1edf-4a4f-b4e8-26aa6ef9adec", - "inserted_at": "2023-02-21T19:42:17.704086Z", + "id": "e4796108-f4d8-4a11-9860-d07b92b08d93", + "inserted_at": "2023-03-29T15:11:47.192265Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "unprivileged", - "updated_at": "2023-02-21T19:42:17.704086Z" + "updated_at": "2023-03-29T15:11:47.192265Z" } } ``` @@ -190,18 +190,18 @@ EOF HTTP/1.1 201 Content-Type: application/json; charset=utf-8 -Location: /v0/users/16ea7401-4eb8-4b48-a711-172ae117ac05 +Location: /v0/users/479ed1cb-1657-4c82-bc32-2200f6cc82e9 { "data": { "disabled_at": null, "email": "new-user@test", - "id": "16ea7401-4eb8-4b48-a711-172ae117ac05", - "inserted_at": "2023-02-21T19:42:17.745811Z", + "id": "479ed1cb-1657-4c82-bc32-2200f6cc82e9", + "inserted_at": "2023-03-29T15:11:47.460359Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "admin", - "updated_at": "2023-02-21T19:42:17.745811Z" + "updated_at": "2023-03-29T15:11:47.460359Z" } } ``` @@ -241,7 +241,7 @@ Content-Type: application/json; charset=utf-8 #### An email can be used instead of ID. **URI Parameters:** - - `id`: `test-6725@test` + - `id`: `test-905@test` ```bash $ curl -i \ -X GET "https://{firezone_host}/v0/users/{id}" \ @@ -254,13 +254,13 @@ Content-Type: application/json; charset=utf-8 { "data": { "disabled_at": null, - "email": "test-6725@test", - "id": "da45a8d6-581c-4e63-96ee-61de158829e4", - "inserted_at": "2023-02-21T19:42:17.575002Z", + "email": "test-905@test", + "id": "d43dae29-0687-456c-a3a4-a461eb744cf5", + "inserted_at": "2023-03-29T15:11:47.340583Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "admin", - "updated_at": "2023-02-21T19:42:17.575002Z" + "updated_at": "2023-03-29T15:11:47.340583Z" } } ``` @@ -272,7 +272,7 @@ For details please see [Create a User](#create-a-user-post-v0users) section. #### Update by email **URI Parameters:** - - `id`: `test-5315@test` + - `id`: `test-1960@test` ```bash $ curl -i \ -X PUT "https://{firezone_host}/v0/users/{id}" \ @@ -290,20 +290,20 @@ Content-Type: application/json; charset=utf-8 { "data": { "disabled_at": null, - "email": "test-5315@test", - "id": "784d4612-c3d0-4072-bb90-036b51db5df5", - "inserted_at": "2023-02-21T19:42:17.585416Z", + "email": "test-1960@test", + "id": "8830b359-2368-4f55-9879-1cb04ee0cbbf", + "inserted_at": "2023-03-29T15:11:47.391921Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "unprivileged", - "updated_at": "2023-02-21T19:42:17.585416Z" + "updated_at": "2023-03-29T15:11:47.391921Z" } } ``` #### Update by ID **URI Parameters:** - - `id`: `966311e8-c718-47e2-9b20-7c87bda1ed83` + - `id`: `d542e1bc-25b2-453d-ae14-41f8f81605ee` ```bash $ curl -i \ -X PUT "https://{firezone_host}/v0/users/{id}" \ @@ -321,13 +321,13 @@ Content-Type: application/json; charset=utf-8 { "data": { "disabled_at": null, - "email": "test-4262@test", - "id": "966311e8-c718-47e2-9b20-7c87bda1ed83", - "inserted_at": "2023-02-21T19:42:17.487017Z", + "email": "test-1513@test", + "id": "d542e1bc-25b2-453d-ae14-41f8f81605ee", + "inserted_at": "2023-03-29T15:11:47.475440Z", "last_signed_in_at": null, "last_signed_in_method": null, "role": "unprivileged", - "updated_at": "2023-02-21T19:42:17.487017Z" + "updated_at": "2023-03-29T15:11:47.475440Z" } } ``` @@ -338,7 +338,7 @@ Content-Type: application/json; charset=utf-8 #### Example **URI Parameters:** - - `id`: `a1a32c77-d55a-47a5-94ba-6ea065efdc18` + - `id`: `31156bf6-73de-4d9b-aa1e-2e419a45dd25` ```bash $ curl -i \ -X DELETE "https://{firezone_host}/v0/users/{id}" \ @@ -351,7 +351,7 @@ Content-Type: application/json; charset=utf-8 #### An email can be used instead of ID. **URI Parameters:** - - `id`: `test-7109@test` + - `id`: `test-4996@test` ```bash $ curl -i \ -X DELETE "https://{firezone_host}/v0/users/{id}" \ diff --git a/www/docs/reference/reverse-proxy-templates/traefik.mdx b/www/docs/reference/reverse-proxy-templates/traefik.mdx index b92f4c88b..d38c7a9a7 100644 --- a/www/docs/reference/reverse-proxy-templates/traefik.mdx +++ b/www/docs/reference/reverse-proxy-templates/traefik.mdx @@ -8,16 +8,16 @@ proxy as a reverse proxy for Firezone. In these examples, we assume Traefik is deployed using Docker on the same host as Firezone. For this to work, you'll need to make sure -`EXTERNAL_TRUSTED_PROXIES` is set to include the Docker address of the Traefik -service. +`PHOENIX_EXTERNAL_TRUSTED_PROXIES` is set to include the Docker address of the +Traefik service. ## Without SSL termination Since Firezone requires HTTPS for the web portal, please bear in mind a downstream proxy will need to terminate SSL connections in this scenario. -Use the following `docker-compose.yml` and `rules.yml` files as a starting -point for your own Firezone config: +Use the following `docker-compose.yml` and `rules.yml` files as a starting point +for your own Firezone config: ### `docker-compose.yml` @@ -193,7 +193,7 @@ services: DATABASE_ENCRYPTION_KEY: ${DATABASE_ENCRYPTION_KEY:?err} # Ensure this includes the traefik service IP. - EXTERAL_TRUSTED_PROXIES: [""] + PHOENIX_EXTERNAL_TRUSTED_PROXIES: [""] networks: - app cap_add: