Skip to content

Configuration reference

Apply settings to the process that owns them. The table below lists runtime environment keys; Compose interpolation variables such as RATELDESK_VERSION serve a different purpose.

Environment keyServicePurpose
ApiBaseUrlWebAPI destination, such as http://api:8222/
Authentication__ModeWeb and APIExplicit Local, Oidc, or Hybrid account authentication
Authentication__AllowInsecureLocalhostWeb and APILocalhost HTTP exception; remove for public HTTPS
DataProtection__KeyRingPathWeb and APIDurable key-ring location
Bootstrap__StateDirectoryAPIDurable installation descriptor and setup state
Bootstrap__DataDirectoryAPIBootstrap-managed data directory
StorageOptions__RootPathAPIDurable attachment and image storage outside wwwroot
Database__ProviderAPISqlite or PostgreSql for explicitly deployment-managed storage
ConnectionStrings__HelpdeskDbAPIDeployment-managed PostgreSQL connection string
WebGateway__PublicOriginWebTrusted public HTTPS origin without a path
IntegrationCredentials__Pairing__PublicOriginAPITrusted HTTPS origin used for browser credential approval

The first-run wizard can manage database initialization without a normal runtime connection-string environment variable. Established installations retain their saved storage identity. Do not point an initialized descriptor at a different database to recover it.

For browser-approved clients, set both public-origin keys to the intended instance origin, for example https://helpdesk.example.com. A private container address is not a public approval URL.

Enable Web’s route and configure the MCP service together. Selecting a Compose profile alone cannot alter Web’s environment.

Environment keyServiceGateway example
WebGateway__Mcp__EnabledWebtrue
WebGateway__Mcp__DestinationWebhttp://mcp-http:8223/
WebGateway__Mcp__PublicResourceUriWebhttps://helpdesk.example.com/mcp
WebGateway__Mcp__AuthenticationModeWebgateway
Helpdesk__Mcp__InstanceMCPproduction
Helpdesk__Mcp__ExpectedApiBaseUrlMCPhttp://api:8222/
Helpdesk__Mcp__PublicResourceUriMCPThe same canonical HTTPS /mcp resource
Helpdesk__Mcp__AllowedOrigins__0MCPhttps://helpdesk.example.com
Helpdesk__Mcp__AuthenticationModeMCPgateway
Helpdesk__Mcp__Outbound__ApiBaseUrlMCPhttp://api:8222/
Helpdesk__Mcp__Outbound__CredentialModeMCPgateway

Gateway mode has no downstream credential to supply. The expected and configured API targets must match. Browser origins contain no path; a mismatching Origin is rejected. Non-browser MCP clients may omit that header.

Use HTTP MCP setup to review and verify an existing deployment. Advanced external Authentik mode has different ingress and downstream identities; use the complete mode and field reference.

RATELDESK_CONFIG selects a CLI file. RATELDESK_MCP_CONFIG selects an isolated MCP file. API-purpose clients can use the supported INTEGRATION_CREDENTIAL_FILE setting under their respective RATELDESK_ or RATELDESK_MCP_ prefix. Arbitrary _FILE settings are not automatically supported.

Native chat can be configured through the Integration hub or through the API service:

Netclaw__Enabled=true
Netclaw__Instance=production
Netclaw__Endpoint=https://netclaw.example.com/hub/session
Netclaw__DeviceToken=<INJECTED_PAIRED_DEVICE_TOKEN>
Netclaw__AllowPrivateHttp=false

Inject the device token through protected deployment configuration. Deployment-managed profiles are read-only in the UI. Native chat still requires PostgreSQL.

Compose .env supplies interpolation values; it does not inject every entry into every container. A service’s environment supplies the actual runtime keys and overrides matching env_file entries. Review the rendered deployment and recreate affected services. Editing an environment file does not change a running process.

Sources: Gateway configuration, self-hosting, and Netclaw settings.

RatelDesk 0.1.2-beta.17 · Reviewed 2026-10-30
Product home · Release downloads · Report a documentation issue