Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix docs typos #1532

Merged
merged 2 commits into from
Mar 29, 2023
Merged

Fix docs typos #1532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f40b4c
Fix docs COOKIE_SIGNING_SALT desc
jamilbk Mar 29, 2023
fae15ec
Use PHOENIX_EXTERNAL_TRUSTED_PROXIES
jamilbk Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apps/fz_http/lib/fz_http/config/definitions.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,15 +367,15 @@ 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,
changeset: &FzHttp.Validator.validate_base64/2
)

@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,
Expand Down
4 changes: 2 additions & 2 deletions www/docs/reference/env-vars.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 6 additions & 6 deletions www/docs/reference/rest-api/configurations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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
}
}
Expand Down
134 changes: 67 additions & 67 deletions www/docs/reference/rest-api/devices.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand All @@ -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": [
Expand All @@ -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": [
Expand All @@ -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": [
Expand All @@ -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"
}
]
}
Expand Down Expand Up @@ -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": {
Expand All @@ -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,
Expand All @@ -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"
}
}
```
Expand All @@ -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}" \
Expand All @@ -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"
}
}
```
Expand All @@ -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}" \
Expand Down Expand Up @@ -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,
Expand All @@ -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"
}
}
```
Expand All @@ -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}" \
Expand Down
Loading