Skip to content

docs: Update env vars and nginx config #57

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

Merged
timokoessler merged 1 commit into from
Jul 8, 2026
Merged

docs: Update env vars and nginx config #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 12 additions & 11 deletions content/docs/configuration/env-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,18 @@ 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 |
| `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

Expand Down
4 changes: 4 additions & 0 deletions content/docs/guides/reverse-proxy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ server {
# Required for WebSocket connections.
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;

# Prevent Websocket being closed by Nginx
proxy_send_timeout 120s;
proxy_read_timeout 120s;
}
}
```
Expand Down