fosrl/docs
1
0
Fork 0
mirror of https://github.com/fosrl/docs.git synced 2025-05-13 05:40:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs to include config.yml changes

Browse source
This commit is contained in:
Milo Schwartz 2025-01-16 00:10:51 -05:00
parent 5b1123cf67
commit 13e3753cfc
No known key found for this signature in database
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
packages/docusaurus/docs/03-Pangolin/02-Configuration/02-config.md
View file

@ -7,10 +7,12 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
### `app` ### `app`
- `dashboard_url`: string - `dashboard_url`: string
- Env: APP_DASHBOARDURL
- Example: `https://example.com` or `https://proxy.example.com` - Example: `https://example.com` or `https://proxy.example.com`
- The url where the application is hosted. This is used for many things, including generating links. - The url where the application is hosted. This is used for many things, including generating links.
- You can run Pangolin on a subdomain or root domain. Users will be redirected to this url to complete the auth step. - You can run Pangolin on a subdomain or root domain. Users will be redirected to this url to complete the auth step.
- `base_domain`: string - `base_domain`: string
- Env: APP_BASEDOMAIN
- Example: `example.com` - Example: `example.com`
- The base domain for the application. This is used for setting cookies and determining the base domain for resources. - The base domain for the application. This is used for setting cookies and determining the base domain for resources.
- `log_level`: string - `log_level`: string
@ -25,10 +27,13 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
### `server` ### `server`
- `external_port`: int - `external_port`: int
- Env: SERVER_EXTERNALPORT
- The port the external facing (public) API will listen on. - The port the external facing (public) API will listen on.
- `internal_port`: int - `internal_port`: int
- Env: SERVER_INTERNALPORT
- The port the internal private facing (private) API will listen on. - The port the internal private facing (private) API will listen on.
- `next_port`: int - `next_port`: int
- Env: SERVER_NEXTPORT
- The port the frontend server will listen on. - The port the frontend server will listen on.
- `internal_hostname`: string - `internal_hostname`: string
- Example: `pangolin` - Example: `pangolin`
@ -45,6 +50,23 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
- `resource_access_token_param`: string - `resource_access_token_param`: string
- Example: `p_token` - Example: `p_token`
- The query parameter used to pass the access token to the resource. Badger extracts this token and sends it to Pangolin to authenticate. This is used in direct share links that do not require a browser redirect. - The query parameter used to pass the access token to the resource. Badger extracts this token and sends it to Pangolin to authenticate. This is used in direct share links that do not require a browser redirect.
- `cors`: object (optional)
- Configuration for Cross-Origin Resource Sharing (CORS).
- `origins`: array of strings (optional)
- Example: `["https://proxy.example.com"]`
- List of allowed origins for cross-origin requests.
- `methods`: array of strings (optional)
- Example: `["GET", "POST", "PUT", "DELETE", "PATCH"]`
- HTTP methods allowed for CORS requests.
- `allowed_headers`: array of strings (optional)
- Example: `["X-CSRF-Token", "Content-Type"]`
- HTTP headers allowed in CORS requests.
- `credentials`: boolean (optional)
- Whether to allow credentials.
- Default: true
- `trust_proxy`: boolean (optional)
- Whether to trust the proxy headers (e.g., `X-Forwarded-For`) for determining the client IP address.
- Default: `true`
### `traefik` ### `traefik`
@ -63,8 +85,10 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
### `gerbil` ### `gerbil`
- `start_port`: int - `start_port`: int
- Env: GERBIL_STARTPORT
- This is the starting port for WireGuard tunnels that new Gerbil exit nodes will use and increment as they register with Pangolin. Advised to choose a base of a range with no conflicts. - This is the starting port for WireGuard tunnels that new Gerbil exit nodes will use and increment as they register with Pangolin. Advised to choose a base of a range with no conflicts.
- `base_endpoint`: string - `base_endpoint`: string
- Env: GERBIL_BASEENDPOINT
- This is the domain name automatically included in Newt and WireGuard config for tunnel connections. - This is the domain name automatically included in Newt and WireGuard config for tunnel connections.
- `use_subdomain`: boolean - `use_subdomain`: boolean
- If set to true, new Gerbil exit nodes will be assigned a unique subdomain off of the base domain. Advised to keep this to false. - If set to true, new Gerbil exit nodes will be assigned a unique subdomain off of the base domain. Advised to keep this to false.
@ -105,8 +129,10 @@ Pangolin is configured using a `config.yml` file. The file is expected to be mou
- `server_admin`: object - `server_admin`: object
- The server admin who can always create new organizations. This user will always be created on startup. - The server admin who can always create new organizations. This user will always be created on startup.
- `email`: string - `email`: string
- Env: USERS_SERVERADMIN_EMAIL
- The email address of the server admin. - The email address of the server admin.
- `password`: string - `password`: string
- Env: USERS_SERVERADMIN_PASSWORD
- The password of the server admin. - The password of the server admin.
- This password will always overwrite the password in the database on startup. This is useful for resetting the password. - This password will always overwrite the password in the database on startup. This is useful for resetting the password.
- The password must meet the following requirements: - The password must meet the following requirements: