Skip to content

Configuration reference

AuthProxy configuration is YAML validated against the canonical JSON Schema at internal/schema/config/schema.json. The development configuration demonstrates the full server shape at dev_config/default.yaml.

Block Purpose
public, api, admin_api, worker Enabled services, ports, TLS, UI, and health behavior
host_application, marketplace Browser login handoff and Marketplace URL
system_auth JWT, actors, global encryption key, and DEK policy
database, redis Primary database and distributed state
app_metrics Request-event, resource-metric, and optional blob storage
connectors Connector loading, migration, and identifying labels
tasks Task retention and worker behavior
telemetry OTLP exporter, signals, sampling, and label projection

Fields can use AuthProxy value sources such as direct development values, environment variables, and file paths. Never put production credentials or key material directly in a committed YAML file.

The Helm chart exposes typed values for common deployment settings and merges config as an advanced overlay. Its reference is deploy/charts/authproxy/values.yaml with validation in values.schema.json.

Prefer typed chart values for database, Redis, service, ingress, Secret, and storage configuration. Use the free-form overlay only when a server setting has not yet been promoted into the chart schema.

Start the server or render the chart in CI to exercise schema validation. For repository changes, run:

Terminal window
./scripts/preflight.sh

Connector definitions have their own schema and authoring guides; continue with connector setup flows and connector predicates.