Skip to content

Configuration reference

NetRatel uses standard .NET configuration. A colon-separated application key becomes a double-underscore environment variable: Authentication:Mode becomes Authentication__Mode.

The release bundle’s .env inputs are a separate layer. Compose maps those inputs into application variables; a custom stack must provide the application variables itself.

PurposeApplication/container settingSupplied Compose input
Browser authenticationAuthentication__Mode on API and WebNETRATEL_AUTHENTICATION_MODE
PostgreSQL connectionConnectionStrings__NetRatelDbConstructed from the bundle’s PostgreSQL inputs, or supplied for external PostgreSQL.
Public Web/API originBranding__SiteUrl on APINETRATEL_PUBLIC_ORIGIN
Public native gateway originBranding__GatewayUrl on APINETRATEL_PUBLIC_GATEWAY_ORIGIN
API Data Protection keysDataProtection__KeysDirectoryPersistent key-volume mount.
Web key directoryNetRatel_KEYS_DIRShared persistent key-volume mount.
Native-agent signing keyAgentAuth__PrivateKeyPathFile mounted through NETRATEL_AGENT_AUTH_PRIVATE_KEY.

Choose Local, Oidc or Hybrid explicitly. Auto selects OIDC when supported OIDC settings are present and Local otherwise; it does not offer both methods.

For generated installers, public Web and Gateway origins must both be configured. The same hostname can serve both, but it must be entered explicitly for each role. These origins are separate from Web’s internal ApiBaseUrl and the identity provider’s issuer.

Update the saved environment/configuration source, validate the Compose configuration, then recreate the affected services. A container restart retains the old environment values.

Keep deployment-owned secrets in the configured secret mechanism. When a setting comes from a mounted file or injected environment, change that source rather than expecting a setup wizard to edit it.

The client reads packaged defaults, installed clientsettings.json, deployment environment variables and supported command-line overrides, in that order. Later sources take precedence. Container clients support:

NetRatelCLIENT__Client__ApiBaseUrl=https://netratel.example.com
NetRatelCLIENT__Gateway__Endpoint=https://grpc.example.com

An existing enrolled identity is stored separately from these endpoint settings. Preserve it during updates.

Use Local, OIDC and Hybrid for login configuration. Use HTTP MCP for its separate ingress, outbound and delegation settings, and stdio MCP for local MCP profiles.

Complete v0.1.2 deployment configuration

NetRatel 0.1.2 · Reviewed 2026-10-30
Product home · Release downloads · Report a documentation issue