diff --git a/content/docs/configuration/env-variables.mdx b/content/docs/configuration/env-variables.mdx index 40d901c..b063c18 100644 --- a/content/docs/configuration/env-variables.mdx +++ b/content/docs/configuration/env-variables.mdx @@ -17,24 +17,24 @@ These environment variables can be used in both the agent and the hub. ## Hub -| Variable | Default Value | Recommended to change | Description | -| ------------------------------------- | ------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APP_URL` | `-` | yes (required) | The URL of the OrcaCD instance | -| `APP_SECRET` | `-` | yes (required) | Secret used for authentication and encryption. Generate one with `openssl rand -base64 42` | -| `HOST` | `0.0.0.0` | no | Host address | -| `PORT` | `8080` | no | Container port | -| `DISABLE_LOCAL_AUTH` | `false` | no | Disable password authentication. Useful when using SSO with OIDC | -| `TRUSTED_PROXIES` | `-` | no | Recommended if using a reverse proxy. Comma seperated list of network origins | -| `ALLOWED_IPS` | `-` | no | Harden the hub by only allowing requests from certain IPs. Comma seperated list of CIDR ranges or single IPs. This does not apply to webhooks or the agent connections. | -| `RESTRICT_VOLUMES_TO_DEPLOYMENTS_DIR` | `false` | no | Restrict the volumes that can be mounted to locations within the OrcaCD deployments directory. This enhances security. | -| `ALLOWED_PRIVILEGED_APPS` | `-` | no | Comma seperated list of app id that are allowed to bypass certain restrictions enforced by OrcaCD | -| `DISABLE_UI` | `false` | no | Disable serving the frontend. Useful when using the hub only for API access. | -| `ALLOWED_INTERNAL_IPS` | `-` | no | Private IPs that should be ignored by the SSRF protection. Comma seperated list of CIDR ranges or single IPs | -| `DEMO` | `false` | no | This mode disables all functions except the login and additionally seeds some demo data in the database | +| Variable | Default Value | Recommended to change | Description | +| ---------------------- | ------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `APP_URL` | `-` | yes (required) | The URL of the OrcaCD instance | +| `APP_SECRET` | `-` | yes (required) | Secret used for authentication and encryption. Generate one with `openssl rand -base64 42` | +| `HOST` | `0.0.0.0` | no | Host address | +| `PORT` | `8080` | no | Container port | +| `DISABLE_LOCAL_AUTH` | `false` | no | Disable password authentication. Useful when using SSO with OIDC | +| `TRUSTED_PROXIES` | `-` | no | Recommended if using a reverse proxy. Comma seperated list of network origins | +| `ALLOWED_IPS` | `-` | no | Harden the hub by only allowing requests from certain IPs. Comma seperated list of CIDR ranges or single IPs. This does not apply to webhooks or the agent connections. | +| `DISABLE_UI` | `false` | no | Disable serving the frontend. Useful when using the hub only for API access. | +| `ALLOWED_INTERNAL_IPS` | `-` | no | Private IPs that should be ignored by the SSRF protection. Comma seperated list of CIDR ranges or single IPs | +| `DEMO` | `false` | no | This mode disables all functions except the login and additionally seeds some demo data in the database | ## Agent -| Variable | Default Value | Recommended to change | Description | -| ------------ | ------------- | --------------------- | ------------------------------------------------------------------------------------------- | -| `HUB_URL` | `-` | yes (required) | The URL of the Hub. Example: `https://example.com` | -| `AUTH_TOKEN` | `- ` | yes (required) | The authentication token of the agent. Register an agent in the hub frontend to retrieve it | +| Variable | Default Value | Recommended to change | Description | +| ------------------------------------- | ------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `HUB_URL` | `-` | yes (required) | The URL of the Hub. Example: `https://example.com` | +| `AUTH_TOKEN` | `- ` | yes (required) | The authentication token of the agent. Register an agent in the hub frontend to retrieve it | +| `RESTRICT_VOLUMES_TO_DEPLOYMENTS_DIR` | `false` | no | Restrict the volumes that can be mounted to locations within the OrcaCD deployments directory. This enhances security. | +| `ALLOWED_PRIVILEGED_APPS` | `-` | no | Comma seperated list of app id that are allowed to bypass certain restrictions enforced by OrcaCD |