reference.md Raw History Folder

Configuration Reference

Complete configuration reference with all options and their default values.

Full Configuration Example

# =============================================================================
# SERVER
# =============================================================================
[server]
port = 8088                                  # HTTP proxy port
registry_port = 5000                         # Container registry port
tls_port = 8443                              # HTTPS proxy port (0 = disabled, no internal CA)
tls_cert_file = ""                           # PEM cert path (optional, for static TLS alongside internal CA)
tls_key_file = ""                            # PEM key path (optional, must be set with tls_cert_file)
force_https_redirect = false                 # Redirect all HTTP traffic to HTTPS (for direct-access setups)
gordon_domain = ""                           # Required: Gordon domain (registry + API)
data_dir = "~/.gordon"                       # Data directory (varies by install type)
max_blob_chunk_size = "95MB"                 # Max size per registry blob upload chunk
max_blob_size = "1GB"                        # Max cumulative size per registry blob/layer upload
registry_allowed_ips = []                    # IPs or CIDR ranges allowed to access the registry (empty = allow all)
proxy_allowed_ips = []                       # IPs or CIDR ranges allowed to reach the proxy (empty = allow all, e.g. Cloudflare IPs)
registry_listen_address = ""                 # Bind address for registry (empty = all interfaces, "127.0.0.1" = loopback only)

# =============================================================================
# DNS
# =============================================================================
[dns]
resolvers = ["1.1.1.1:53", "8.8.8.8:53"] # Recursive resolvers for public DNS visibility checks
propagation_timeout = "5m"                 # Max wait for DNS-01 TXT propagation
polling_interval = "5s"                    # Interval between DNS-01 propagation checks

# =============================================================================
# AUTHENTICATION (required - Gordon won't start without credentials configured)
# =============================================================================
[auth]
enabled = true                               # Enable registry authentication (default: true)
secrets_backend = "unsafe"                   # "pass", "sops", or "unsafe"
token_secret = ""                            # Path in secrets backend to JWT signing key (REQUIRED)
token_expiry = "30d"                         # Token expiry duration
access_token_ttl = "15m"                     # Ephemeral access token lifetime (default: 15m)

# =============================================================================
# PUBLIC TLS / ACME
# =============================================================================
[tls.acme]
enabled = false                              # Enable public ACME certificates (requires server.tls_port > 0)
email = ""                                   # ACME account email when enabled
challenge = "auto"                           # "auto", "http-01", or "cloudflare-dns-01"
obtain_batch_size = 1                         # New certificate orders per reconcile run

# =============================================================================
# API (applies to both Registry and Admin endpoints)
# =============================================================================
[api.rate_limit]
enabled = true                               # Enable rate limiting (default: true)
global_rps = 500                             # Max requests/second globally
per_ip_rps = 50                              # Max requests/second per client IP
burst = 100                                  # Burst size for rate limiters
trusted_proxies = []                         # IPs/CIDRs trusted to set X-Forwarded-For

# =============================================================================
# LOGGING
# =============================================================================
[logging]
level = "info"                               # "debug", "info", "warn", "error"
format = "console"                           # "console" or "json"

[logging.file]
enabled = false                              # Enable file logging
path = ""                                    # Log file path (default: {data_dir}/logs/gordon.log)
max_size = 100                               # Max size in MB before rotation
max_backups = 3                              # Number of old files to keep
max_age = 28                                 # Days to keep old files

[logging.container_logs]
enabled = true                               # Enable container log collection
dir = ""                                     # Log directory (default: {data_dir}/container-logs)
max_size = 100                               # Max size in MB before rotation
max_backups = 3                              # Number of old files to keep
max_age = 28                                 # Days to keep old files

[logging.access_log]
enabled = false                              # Dedicated HTTP access log for reverse-proxy traffic
format = "json"                             # "json", "clf", or "combined"
output = "stdout"                           # "stdout", "file", or "journald"
file_path = ""                               # Required when output = "file"
max_size = 100                               # Max size in MB before rotation (file output)
max_backups = 3                              # Number of old files to keep (file output)
max_age = 28                                 # Days to keep old files (file output)
exclude_health_checks = true                 # Skip noisy readiness/liveness requests
syslog_identifier = "gordon-access"         # Journald identifier when output = "journald"

# =============================================================================
# TELEMETRY (OpenTelemetry)
# =============================================================================
[telemetry]
enabled = false                              # Enable OTLP telemetry export
endpoint = ""                                # OTLP HTTP endpoint URL
auth_token = ""                              # Base64-encoded user:password for Basic auth
traces = true                                # Export distributed traces
metrics = true                               # Export metrics
logs = true                                  # Bridge zerolog output to OTLP logs
trace_sample_rate = 1.0                      # Fraction of traces to sample (0.0–1.0)

# =============================================================================
# ENVIRONMENT
# =============================================================================
[env]
dir = ""                                     # Env files directory (default: {data_dir}/env)

# =============================================================================
# DEPLOYMENT
# =============================================================================
[deploy]
pull_policy = "if-tag-changed"               # "always", "if-tag-changed", "never"
readiness_mode = "auto"                      # "auto", "docker-health", "delay"
health_timeout = "90s"                       # Max wait for health-based readiness
readiness_delay = "5s"                       # Wait after running before considered ready
drain_mode = "auto"                          # "auto", "inflight", "delay"
drain_timeout = "30s"                        # Max wait for in-flight request drain
drain_delay = "2s"                           # Wait after cache invalidation before old stop

# =============================================================================
# CONTAINERS
# =============================================================================
[containers]
security_profile = "compat"                  # "compat" or "strict"

# =============================================================================
# AUTO-ROUTE
# =============================================================================
[auto_route]
enabled = false                              # Create routes from image labels automatically

# =============================================================================
# NETWORK ISOLATION
# =============================================================================
[network_isolation]
enabled = true                               # Enable per-app Docker networks
network_prefix = "gordon"                    # Prefix for created networks
internal = false                             # Create Docker internal networks (blocks direct egress)

# =============================================================================
# VOLUMES
# =============================================================================
[volumes]
auto_create = true                           # Auto-create volumes from Dockerfile VOLUME
prefix = "gordon"                            # Volume name prefix
preserve = true                              # Keep volumes when containers are removed

# =============================================================================
# ROUTES
# =============================================================================
[routes]
# "domain.com" = { image = "image:tag" }
# "insecure.domain.com" = { image = "image:tag", https = false }
# Legacy "http://domain.com" keys are read for compatibility and rewritten on save.

# =============================================================================
# EXTERNAL ROUTES
# =============================================================================
[external_routes]
# "domain.com" = "host:port"                 # Proxy to non-container services

# =============================================================================
# NETWORK GROUPS
# =============================================================================
[network_groups]
# "group-name" = ["domain1.com", "domain2.com"]

# =============================================================================
# ATTACHMENTS
# =============================================================================
[attachments]
# "domain-or-group" = ["image1:tag", "image2:tag"]

# =============================================================================
# BACKUPS
# =============================================================================
[backups]
enabled = false                              # Enable backup service
schedule = "daily"                          # "hourly", "daily", "weekly", "monthly"
storage_dir = ""                            # Backup root (default: {data_dir}/backups)

[backups.retention]
hourly = 0                                   # Keep N hourly backups per DB
daily = 0                                    # Keep N daily backups per DB
weekly = 0                                   # Keep N weekly backups per DB
monthly = 0                                  # Keep N monthly backups per DB

# =============================================================================
# IMAGES
# =============================================================================
[images]
allowed_registries = []
require_digest = false

[images.prune]
enabled = false                              # Enable scheduled image cleanup
schedule = "daily"                          # "hourly", "daily", "weekly", "monthly"
keep_last = 3                                # Keep N newest tags per repository

# Note: retention values set to 0 keep no backups for that tier.
# For practical defaults, consider setting daily = 7.

Default Values Summary

Setting	Default	Description
`server.port`	`8088`	HTTP proxy port
`server.registry_port`	`5000`	Container registry port
`server.tls_port`	`8443`	HTTPS listener port (0 = disabled)
`server.tls_cert_file`	`""`	PEM cert path for static TLS (optional)
`server.tls_key_file`	`""`	PEM key path for static TLS (optional)
`server.force_https_redirect`	`false`	Redirect all HTTP to HTTPS (for direct-access setups)
`server.gordon_domain`	`""`	Required - Gordon domain
`server.data_dir`	`~/.gordon`	Data directory
`server.max_blob_chunk_size`	`"95MB"`	Max size per registry blob upload chunk
`server.max_blob_size`	`"1GB"`	Max cumulative size per registry blob/layer upload
`server.registry_allowed_ips`	`[]`	IPs or CIDR ranges allowed to access the registry (empty = allow all)
`server.proxy_allowed_ips`	`[]`	IPs or CIDR ranges allowed to reach the proxy (empty = allow all)
`server.registry_listen_address`	`""`	Bind address for registry (empty = all interfaces)
`dns.resolvers`	`["1.1.1.1:53", "8.8.8.8:53"]`	Recursive resolvers used for public DNS visibility checks, including ACME DNS-01 propagation
`dns.propagation_timeout`	`"5m"`	Maximum time to wait for DNS-01 TXT records to become visible through configured recursive resolvers
`dns.polling_interval`	`"5s"`	Interval between DNS-01 propagation checks
`tls.acme.enabled`	`false`	Enable public ACME certificates (requires `server.tls_port > 0`)
`tls.acme.email`	`""`	ACME account email when enabled
`tls.acme.challenge`	`"auto"`	ACME challenge mode: `auto`, `http-01`, or `cloudflare-dns-01`
`tls.acme.obtain_batch_size`	`1`	Maximum new ACME certificate orders per reconcile run
`auth.enabled`	`true`	Enable authentication; when `false`, run local-only mode (loopback-only `/v2/`, `/admin/` disabled)
`auth.secrets_backend`	`"unsafe"`	Secrets storage
`auth.token_expiry`	`"30d"`	30 days
`auth.access_token_ttl`	`"15m"`	Ephemeral access token lifetime
`api.rate_limit.enabled`	`true`	Enable rate limiting
`api.rate_limit.global_rps`	`500`	Global requests/second
`api.rate_limit.per_ip_rps`	`50`	Per-IP requests/second
`api.rate_limit.burst`	`100`	Burst size
`api.rate_limit.trusted_proxies`	`[]`	IPs/CIDRs trusted for X-Forwarded-For
`logging.level`	`"info"`	Log level
`logging.format`	`"console"`	Log format
`logging.file.enabled`	`false`	File logging disabled
`logging.file.max_size`	`100`	100 MB
`logging.file.max_backups`	`3`	Keep 3 old files
`logging.file.max_age`	`28`	28 days
`logging.container_logs.enabled`	`true`	Container logs enabled
`logging.container_logs.max_size`	`100`	100 MB
`logging.container_logs.max_backups`	`3`	Keep 3 old files
`logging.container_logs.max_age`	`28`	28 days
`logging.access_log.enabled`	`false`	Dedicated HTTP access log disabled
`logging.access_log.format`	`"json"`	Access log format (`json`, `clf`, `combined`)
`logging.access_log.output`	`"stdout"`	Access log sink (`stdout`, `file`, `journald`)
`logging.access_log.max_size`	`100`	100 MB for file output
`logging.access_log.max_backups`	`3`	Keep 3 old files for file output
`logging.access_log.max_age`	`28`	28 days for file output
`logging.access_log.exclude_health_checks`	`true`	Skip health-check requests
`logging.access_log.syslog_identifier`	`"gordon-access"`	Journald identifier
`telemetry.enabled`	`false`	Enable OTLP telemetry export
`telemetry.endpoint`	`""`	OTLP HTTP endpoint URL
`telemetry.auth_token`	`""`	Base64 `user:password` for Basic auth
`telemetry.traces`	`true`	Export distributed traces
`telemetry.metrics`	`true`	Export metrics
`telemetry.logs`	`true`	Bridge zerolog to OTLP logs
`telemetry.trace_sample_rate`	`1.0`	Fraction of traces to sample (0.0–1.0)
`deploy.pull_policy`	`"if-tag-changed"`	Pull on tag change
`deploy.readiness_mode`	`"auto"`	Readiness strategy (`auto`, `docker-health`, `delay`)
`deploy.health_timeout`	`"90s"`	Max wait for health-based readiness before deploy fails
`deploy.readiness_delay`	`"5s"`	Delay before container is considered ready
`deploy.drain_mode`	`"auto"`	Drain strategy (`auto`, `inflight`, `delay`)
`deploy.drain_timeout`	`"30s"`	Max wait for in-flight request drain before old stop
`deploy.drain_delay`	`"2s"`	Delay before stopping previous container after cache invalidation
`containers.security_profile`	`"compat"`	Runtime hardening profile: `compat` preserves existing behavior, `strict` enables read-only rootfs and narrower capabilities
`auto_route.enabled`	`false`	Auto-route disabled
`network_isolation.enabled`	`true`	Network isolation enabled
`network_isolation.network_prefix`	`"gordon"`	Network prefix
`network_isolation.internal`	`false`	Create Docker internal networks without direct external egress
`volumes.auto_create`	`true`	Auto-create volumes
`volumes.prefix`	`"gordon"`	Volume prefix
`volumes.preserve`	`true`	Keep volumes
`backups.enabled`	`false`	Backup service disabled
`backups.schedule`	`"daily"`	Backup scheduler preset
`backups.storage_dir`	`""`	Uses `{server.data_dir}/backups` when empty
`backups.retention.hourly`	`0`	Keep no hourly backups by default
`backups.retention.daily`	`0`	Keep no daily backups by default (recommend `7`)
`backups.retention.weekly`	`0`	Keep no weekly backups by default
`backups.retention.monthly`	`0`	Keep no monthly backups by default
`images.allowed_registries`	`[]`	Explicit external registry allowlist; empty rejects explicit external registries; dangerous local/private registries are always rejected
`images.require_digest`	`false`	Require digest-pinned references for allowlisted external registries
`images.prune.enabled`	`false`	Scheduled image cleanup disabled
`images.prune.schedule`	`"daily"`	Cleanup schedule preset
`images.prune.keep_last`	`3`	Number of recent tags kept per repository

Note: for all backups.retention.* keys, 0 means keep no backups for that retention tier.

Environment Variables

All configuration options can be set via environment variables using the pattern:

GORDON_<SECTION>_<KEY>=value

Examples:

GORDON_SERVER_PORT=8088
GORDON_SERVER_GORDON_DOMAIN=gordon.example.com
GORDON_AUTH_ENABLED=true
GORDON_LOGGING_LEVEL=debug
GORDON_NETWORK_ISOLATION_ENABLED=true

Nested keys use underscores:

GORDON_LOGGING_FILE_ENABLED=true
GORDON_LOGGING_FILE_MAX_SIZE=200
GORDON_LOGGING_CONTAINER_LOGS_ENABLED=false

Security Environment Variables

These special environment variables take priority over config file values:

Variable	Description
`GORDON_AUTH_TOKEN_SECRET`	JWT signing secret (avoids storing secret on disk)

Example:

export GORDON_AUTH_TOKEN_SECRET="your-secure-32-char-secret-here"
gordon serve

Pull Policy Options

Value	Behavior
`"always"`	Always pull image before deploying
`"if-tag-changed"`	Pull only if image tag differs from running container
`"never"`	Never pull, use local image only

Secrets Backend Options

Value	Description
`"pass"`	Unix password manager (recommended for production)
`"sops"`	Mozilla SOPS encrypted files
`"unsafe"`	Plain text files (development only)

Log Level Options

Value	Description
`"debug"`	Verbose debugging information
`"info"`	General operational information
`"warn"`	Warning conditions
`"error"`	Error conditions only

source

1# Configuration Reference
2
3Complete configuration reference with all options and their default values.
4
5## Full Configuration Example
6
7```toml
8# =============================================================================
9# SERVER
10# =============================================================================
11[server]
12port = 8088                                  # HTTP proxy port
13registry_port = 5000                         # Container registry port
14tls_port = 8443                              # HTTPS proxy port (0 = disabled, no internal CA)
15tls_cert_file = ""                           # PEM cert path (optional, for static TLS alongside internal CA)
16tls_key_file = ""                            # PEM key path (optional, must be set with tls_cert_file)
17force_https_redirect = false                 # Redirect all HTTP traffic to HTTPS (for direct-access setups)
18gordon_domain = ""                           # Required: Gordon domain (registry + API)
19data_dir = "~/.gordon"                       # Data directory (varies by install type)
20max_blob_chunk_size = "95MB"                 # Max size per registry blob upload chunk
21max_blob_size = "1GB"                        # Max cumulative size per registry blob/layer upload
22registry_allowed_ips = []                    # IPs or CIDR ranges allowed to access the registry (empty = allow all)
23proxy_allowed_ips = []                       # IPs or CIDR ranges allowed to reach the proxy (empty = allow all, e.g. Cloudflare IPs)
24registry_listen_address = ""                 # Bind address for registry (empty = all interfaces, "127.0.0.1" = loopback only)
25
26# =============================================================================
27# DNS
28# =============================================================================
29[dns]
30resolvers = ["1.1.1.1:53", "8.8.8.8:53"] # Recursive resolvers for public DNS visibility checks
31propagation_timeout = "5m"                 # Max wait for DNS-01 TXT propagation
32polling_interval = "5s"                    # Interval between DNS-01 propagation checks
33
34# =============================================================================
35# AUTHENTICATION (required - Gordon won't start without credentials configured)
36# =============================================================================
37[auth]
38enabled = true                               # Enable registry authentication (default: true)
39secrets_backend = "unsafe"                   # "pass", "sops", or "unsafe"
40token_secret = ""                            # Path in secrets backend to JWT signing key (REQUIRED)
41token_expiry = "30d"                         # Token expiry duration
42access_token_ttl = "15m"                     # Ephemeral access token lifetime (default: 15m)
43
44# =============================================================================
45# PUBLIC TLS / ACME
46# =============================================================================
47[tls.acme]
48enabled = false                              # Enable public ACME certificates (requires server.tls_port > 0)
49email = ""                                   # ACME account email when enabled
50challenge = "auto"                           # "auto", "http-01", or "cloudflare-dns-01"
51obtain_batch_size = 1                         # New certificate orders per reconcile run
52
53# =============================================================================
54# API (applies to both Registry and Admin endpoints)
55# =============================================================================
56[api.rate_limit]
57enabled = true                               # Enable rate limiting (default: true)
58global_rps = 500                             # Max requests/second globally
59per_ip_rps = 50                              # Max requests/second per client IP
60burst = 100                                  # Burst size for rate limiters
61trusted_proxies = []                         # IPs/CIDRs trusted to set X-Forwarded-For
62
63# =============================================================================
64# LOGGING
65# =============================================================================
66[logging]
67level = "info"                               # "debug", "info", "warn", "error"
68format = "console"                           # "console" or "json"
69
70[logging.file]
71enabled = false                              # Enable file logging
72path = ""                                    # Log file path (default: {data_dir}/logs/gordon.log)
73max_size = 100                               # Max size in MB before rotation
74max_backups = 3                              # Number of old files to keep
75max_age = 28                                 # Days to keep old files
76
77[logging.container_logs]
78enabled = true                               # Enable container log collection
79dir = ""                                     # Log directory (default: {data_dir}/container-logs)
80max_size = 100                               # Max size in MB before rotation
81max_backups = 3                              # Number of old files to keep
82max_age = 28                                 # Days to keep old files
83
84[logging.access_log]
85enabled = false                              # Dedicated HTTP access log for reverse-proxy traffic
86format = "json"                             # "json", "clf", or "combined"
87output = "stdout"                           # "stdout", "file", or "journald"
88file_path = ""                               # Required when output = "file"
89max_size = 100                               # Max size in MB before rotation (file output)
90max_backups = 3                              # Number of old files to keep (file output)
91max_age = 28                                 # Days to keep old files (file output)
92exclude_health_checks = true                 # Skip noisy readiness/liveness requests
93syslog_identifier = "gordon-access"         # Journald identifier when output = "journald"
94
95# =============================================================================
96# TELEMETRY (OpenTelemetry)
97# =============================================================================
98[telemetry]
99enabled = false                              # Enable OTLP telemetry export
100endpoint = ""                                # OTLP HTTP endpoint URL
101auth_token = ""                              # Base64-encoded user:password for Basic auth
102traces = true                                # Export distributed traces
103metrics = true                               # Export metrics
104logs = true                                  # Bridge zerolog output to OTLP logs
105trace_sample_rate = 1.0                      # Fraction of traces to sample (0.0–1.0)
106
107# =============================================================================
108# ENVIRONMENT
109# =============================================================================
110[env]
111dir = ""                                     # Env files directory (default: {data_dir}/env)
112
113# =============================================================================
114# DEPLOYMENT
115# =============================================================================
116[deploy]
117pull_policy = "if-tag-changed"               # "always", "if-tag-changed", "never"
118readiness_mode = "auto"                      # "auto", "docker-health", "delay"
119health_timeout = "90s"                       # Max wait for health-based readiness
120readiness_delay = "5s"                       # Wait after running before considered ready
121drain_mode = "auto"                          # "auto", "inflight", "delay"
122drain_timeout = "30s"                        # Max wait for in-flight request drain
123drain_delay = "2s"                           # Wait after cache invalidation before old stop
124
125# =============================================================================
126# CONTAINERS
127# =============================================================================
128[containers]
129security_profile = "compat"                  # "compat" or "strict"
130
131# =============================================================================
132# AUTO-ROUTE
133# =============================================================================
134[auto_route]
135enabled = false                              # Create routes from image labels automatically
136
137# =============================================================================
138# NETWORK ISOLATION
139# =============================================================================
140[network_isolation]
141enabled = true                               # Enable per-app Docker networks
142network_prefix = "gordon"                    # Prefix for created networks
143internal = false                             # Create Docker internal networks (blocks direct egress)
144
145# =============================================================================
146# VOLUMES
147# =============================================================================
148[volumes]
149auto_create = true                           # Auto-create volumes from Dockerfile VOLUME
150prefix = "gordon"                            # Volume name prefix
151preserve = true                              # Keep volumes when containers are removed
152
153# =============================================================================
154# ROUTES
155# =============================================================================
156[routes]
157# "domain.com" = { image = "image:tag" }
158# "insecure.domain.com" = { image = "image:tag", https = false }
159# Legacy "http://domain.com" keys are read for compatibility and rewritten on save.
160
161# =============================================================================
162# EXTERNAL ROUTES
163# =============================================================================
164[external_routes]
165# "domain.com" = "host:port"                 # Proxy to non-container services
166
167# =============================================================================
168# NETWORK GROUPS
169# =============================================================================
170[network_groups]
171# "group-name" = ["domain1.com", "domain2.com"]
172
173# =============================================================================
174# ATTACHMENTS
175# =============================================================================
176[attachments]
177# "domain-or-group" = ["image1:tag", "image2:tag"]
178
179# =============================================================================
180# BACKUPS
181# =============================================================================
182[backups]
183enabled = false                              # Enable backup service
184schedule = "daily"                          # "hourly", "daily", "weekly", "monthly"
185storage_dir = ""                            # Backup root (default: {data_dir}/backups)
186
187[backups.retention]
188hourly = 0                                   # Keep N hourly backups per DB
189daily = 0                                    # Keep N daily backups per DB
190weekly = 0                                   # Keep N weekly backups per DB
191monthly = 0                                  # Keep N monthly backups per DB
192
193# =============================================================================
194# IMAGES
195# =============================================================================
196[images]
197allowed_registries = []
198require_digest = false
199
200[images.prune]
201enabled = false                              # Enable scheduled image cleanup
202schedule = "daily"                          # "hourly", "daily", "weekly", "monthly"
203keep_last = 3                                # Keep N newest tags per repository
204
205# Note: retention values set to 0 keep no backups for that tier.
206# For practical defaults, consider setting daily = 7.
207```
208
209## Default Values Summary
210
211| Setting | Default | Description |
212|---------|---------|-------------|
213| `server.port` | `8088` | HTTP proxy port |
214| `server.registry_port` | `5000` | Container registry port |
215| `server.tls_port` | `8443` | HTTPS listener port (0 = disabled) |
216| `server.tls_cert_file` | `""` | PEM cert path for static TLS (optional) |
217| `server.tls_key_file` | `""` | PEM key path for static TLS (optional) |
218| `server.force_https_redirect` | `false` | Redirect all HTTP to HTTPS (for direct-access setups) |
219| `server.gordon_domain` | `""` | **Required** - Gordon domain |
220| `server.data_dir` | `~/.gordon` | Data directory |
221| `server.max_blob_chunk_size` | `"95MB"` | Max size per registry blob upload chunk |
222| `server.max_blob_size` | `"1GB"` | Max cumulative size per registry blob/layer upload |
223| `server.registry_allowed_ips` | `[]` | IPs or CIDR ranges allowed to access the registry (empty = allow all) |
224| `server.proxy_allowed_ips` | `[]` | IPs or CIDR ranges allowed to reach the proxy (empty = allow all) |
225| `server.registry_listen_address` | `""` | Bind address for registry (empty = all interfaces) |
226| `dns.resolvers` | `["1.1.1.1:53", "8.8.8.8:53"]` | Recursive resolvers used for public DNS visibility checks, including ACME DNS-01 propagation |
227| `dns.propagation_timeout` | `"5m"` | Maximum time to wait for DNS-01 TXT records to become visible through configured recursive resolvers |
228| `dns.polling_interval` | `"5s"` | Interval between DNS-01 propagation checks |
229| `tls.acme.enabled` | `false` | Enable public ACME certificates (requires `server.tls_port > 0`) |
230| `tls.acme.email` | `""` | ACME account email when enabled |
231| `tls.acme.challenge` | `"auto"` | ACME challenge mode: `auto`, `http-01`, or `cloudflare-dns-01` |
232| `tls.acme.obtain_batch_size` | `1` | Maximum new ACME certificate orders per reconcile run |
233| `auth.enabled` | `true` | Enable authentication; when `false`, run local-only mode (loopback-only `/v2/*`, `/admin/*` disabled) |
234| `auth.secrets_backend` | `"unsafe"` | Secrets storage |
235| `auth.token_expiry` | `"30d"` | 30 days |
236| `auth.access_token_ttl` | `"15m"` | Ephemeral access token lifetime |
237| `api.rate_limit.enabled` | `true` | Enable rate limiting |
238| `api.rate_limit.global_rps` | `500` | Global requests/second |
239| `api.rate_limit.per_ip_rps` | `50` | Per-IP requests/second |
240| `api.rate_limit.burst` | `100` | Burst size |
241| `api.rate_limit.trusted_proxies` | `[]` | IPs/CIDRs trusted for X-Forwarded-For |
242| `logging.level` | `"info"` | Log level |
243| `logging.format` | `"console"` | Log format |
244| `logging.file.enabled` | `false` | File logging disabled |
245| `logging.file.max_size` | `100` | 100 MB |
246| `logging.file.max_backups` | `3` | Keep 3 old files |
247| `logging.file.max_age` | `28` | 28 days |
248| `logging.container_logs.enabled` | `true` | Container logs enabled |
249| `logging.container_logs.max_size` | `100` | 100 MB |
250| `logging.container_logs.max_backups` | `3` | Keep 3 old files |
251| `logging.container_logs.max_age` | `28` | 28 days |
252| `logging.access_log.enabled` | `false` | Dedicated HTTP access log disabled |
253| `logging.access_log.format` | `"json"` | Access log format (`json`, `clf`, `combined`) |
254| `logging.access_log.output` | `"stdout"` | Access log sink (`stdout`, `file`, `journald`) |
255| `logging.access_log.max_size` | `100` | 100 MB for file output |
256| `logging.access_log.max_backups` | `3` | Keep 3 old files for file output |
257| `logging.access_log.max_age` | `28` | 28 days for file output |
258| `logging.access_log.exclude_health_checks` | `true` | Skip health-check requests |
259| `logging.access_log.syslog_identifier` | `"gordon-access"` | Journald identifier |
260| `telemetry.enabled` | `false` | Enable OTLP telemetry export |
261| `telemetry.endpoint` | `""` | OTLP HTTP endpoint URL |
262| `telemetry.auth_token` | `""` | Base64 `user:password` for Basic auth |
263| `telemetry.traces` | `true` | Export distributed traces |
264| `telemetry.metrics` | `true` | Export metrics |
265| `telemetry.logs` | `true` | Bridge zerolog to OTLP logs |
266| `telemetry.trace_sample_rate` | `1.0` | Fraction of traces to sample (0.0–1.0) |
267| `deploy.pull_policy` | `"if-tag-changed"` | Pull on tag change |
268| `deploy.readiness_mode` | `"auto"` | Readiness strategy (`auto`, `docker-health`, `delay`) |
269| `deploy.health_timeout` | `"90s"` | Max wait for health-based readiness before deploy fails |
270| `deploy.readiness_delay` | `"5s"` | Delay before container is considered ready |
271| `deploy.drain_mode` | `"auto"` | Drain strategy (`auto`, `inflight`, `delay`) |
272| `deploy.drain_timeout` | `"30s"` | Max wait for in-flight request drain before old stop |
273| `deploy.drain_delay` | `"2s"` | Delay before stopping previous container after cache invalidation |
274| `containers.security_profile` | `"compat"` | Runtime hardening profile: `compat` preserves existing behavior, `strict` enables read-only rootfs and narrower capabilities |
275| `auto_route.enabled` | `false` | Auto-route disabled |
276| `network_isolation.enabled` | `true` | Network isolation enabled |
277| `network_isolation.network_prefix` | `"gordon"` | Network prefix |
278| `network_isolation.internal` | `false` | Create Docker internal networks without direct external egress |
279| `volumes.auto_create` | `true` | Auto-create volumes |
280| `volumes.prefix` | `"gordon"` | Volume prefix |
281| `volumes.preserve` | `true` | Keep volumes |
282| `backups.enabled` | `false` | Backup service disabled |
283| `backups.schedule` | `"daily"` | Backup scheduler preset |
284| `backups.storage_dir` | `""` | Uses `{server.data_dir}/backups` when empty |
285| `backups.retention.hourly` | `0` | Keep no hourly backups by default |
286| `backups.retention.daily` | `0` | Keep no daily backups by default (recommend `7`) |
287| `backups.retention.weekly` | `0` | Keep no weekly backups by default |
288| `backups.retention.monthly` | `0` | Keep no monthly backups by default |
289| `images.allowed_registries` | `[]` | Explicit external registry allowlist; empty rejects explicit external registries; dangerous local/private registries are always rejected |
290| `images.require_digest` | `false` | Require digest-pinned references for allowlisted external registries |
291| `images.prune.enabled` | `false` | Scheduled image cleanup disabled |
292| `images.prune.schedule` | `"daily"` | Cleanup schedule preset |
293| `images.prune.keep_last` | `3` | Number of recent tags kept per repository |
294
295Note: for all `backups.retention.*` keys, `0` means keep no backups for that retention tier.
296
297## Environment Variables
298
299All configuration options can be set via environment variables using the pattern:
300
301```
302GORDON_<SECTION>_<KEY>=value
303```
304
305Examples:
306```bash
307GORDON_SERVER_PORT=8088
308GORDON_SERVER_GORDON_DOMAIN=gordon.example.com
309GORDON_AUTH_ENABLED=true
310GORDON_LOGGING_LEVEL=debug
311GORDON_NETWORK_ISOLATION_ENABLED=true
312```
313
314Nested keys use underscores:
315```bash
316GORDON_LOGGING_FILE_ENABLED=true
317GORDON_LOGGING_FILE_MAX_SIZE=200
318GORDON_LOGGING_CONTAINER_LOGS_ENABLED=false
319```
320
321### Security Environment Variables
322
323These special environment variables take priority over config file values:
324
325| Variable | Description |
326|----------|-------------|
327| `GORDON_AUTH_TOKEN_SECRET` | JWT signing secret (avoids storing secret on disk) |
328
329Example:
330```bash
331export GORDON_AUTH_TOKEN_SECRET="your-secure-32-char-secret-here"
332gordon serve
333```
334
335## Pull Policy Options
336
337| Value | Behavior |
338|-------|----------|
339| `"always"` | Always pull image before deploying |
340| `"if-tag-changed"` | Pull only if image tag differs from running container |
341| `"never"` | Never pull, use local image only |
342
343## Secrets Backend Options
344
345| Value | Description |
346|-------|-------------|
347| `"pass"` | Unix password manager (recommended for production) |
348| `"sops"` | Mozilla SOPS encrypted files |
349| `"unsafe"` | Plain text files (development only) |
350
351## Log Level Options
352
353| Value | Description |
354|-------|-------------|
355| `"debug"` | Verbose debugging information |
356| `"info"` | General operational information |
357| `"warn"` | Warning conditions |
358| `"error"` | Error conditions only |
359
360## Related
361
362- [Configuration Overview](./index.md)
363- [Authentication](./auth.md)
364- [Telemetry](./telemetry.md)
365- [Network Isolation](./network-isolation.md)
366- [Volumes](./volumes.md)
367- [Images](./images.md)

reference.md RawHistoryFolder