Environment Variables
Complete reference for all OrcaCD configuration options
Below are all the environment variables supported by OrcaCD. These should be configured in your .env file.
Be cautious when modifying environment variables that are not recommended to change.
Each variable is tagged with a Type:
- Required - OrcaCD will not function correctly without this being set.
- Recommended - optional, but recommended to change
- Security - optional, but recommended to harden your deployment.
- Optional - safe to leave at the default value.
General
These environment variables can be used in both the agent and the hub.
| Variable | Default Value | Type | Description |
|---|---|---|---|
LOG_LEVEL | info | Optional | Log level. Options: trace, debug, info, warn, error, fatal |
LOG_JSON | false | Optional | Enable JSON formatted logs. |
Hub
| Variable | Default Value | Type | Description |
|---|---|---|---|
APP_URL | - | Required | The URL of the OrcaCD instance |
APP_SECRET | - | Required | Secret used for authentication and encryption. Generate one with openssl rand -base64 42 |
TRUSTED_PROXIES | - | Recommended | Recommended if using a reverse proxy. Comma seperated list of network origins |
DISABLE_LOCAL_AUTH | false | Security | Disable password authentication. Useful when using SSO with OIDC |
ALLOWED_IPS | - | Security | 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. |
HOST | 0.0.0.0 | Optional | Host address |
PORT | 8080 | Optional | Container port |
DISABLE_UI | false | Optional | Disable serving the frontend. Useful when using the hub only for API access. |
ALLOWED_INTERNAL_IPS | - | Optional | Private IPs that should be ignored by the SSRF protection. Comma seperated list of CIDR ranges or single IPs |
DEMO | false | Optional | This mode disables all functions except the login and additionally seeds some demo data in the database |
Agent
| Variable | Default Value | Type | Description |
|---|---|---|---|
HUB_URL | - | Required | The URL of the Hub. Example: https://example.com |
AUTH_TOKEN | - | Required | The authentication token of the agent. Register an agent in the hub frontend to retrieve it |
RESTRICT_VOLUMES_TO_DEPLOYMENTS_DIR | false | Security | Restrict the volumes that can be mounted to locations within the OrcaCD deployments directory. This enhances security. |
ALLOWED_PRIVILEGED_APPS | - | Optional | Comma seperated list of app id that are allowed to bypass certain restrictions enforced by OrcaCD |
Last updated on