reference.md Raw History Folder

Configuration Reference

Complete configuration reference with all options and their default values.

Full Configuration Example

# =============================================================================
# SERVER
# =============================================================================
[server]
port = 80                                    # HTTP proxy port
registry_port = 5000                         # Container registry port
tls_enabled = false                          # Enable native HTTPS listener
tls_port = 443                               # HTTPS proxy port when enabled
tls_cert_file = ""                           # PEM cert path (auto-generated if empty and TLS enabled)
tls_key_file = ""                            # PEM key path (auto-generated if empty and TLS enabled)
gordon_domain = ""                           # Required: Gordon domain (registry + API)
data_dir = "~/.gordon"                       # Data directory (varies by install type)
max_blob_chunk_size = "512MB"                # Max size per registry blob upload chunk
registry_allowed_ips = []                    # IPs or CIDR ranges allowed to access the registry (empty = allow all)

# =============================================================================
# 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 = "720h"                        # Token expiry duration (720h = 30 days)
access_token_ttl = "15m"                     # Ephemeral access token lifetime (default: 15m)

# =============================================================================
# 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

# =============================================================================
# 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

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

# =============================================================================
# NETWORK ISOLATION
# =============================================================================
[network_isolation]
enabled = false                              # Enable per-app Docker networks
network_prefix = "gordon"                    # Prefix for created networks

# =============================================================================
# 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:tag"
# "http://insecure.domain.com" = "image:tag"   # HTTP-only (no HTTPS redirect)

# =============================================================================
# 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.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`	`80`	HTTP proxy port
`server.registry_port`	`5000`	Container registry port
`server.tls_enabled`	`false`	Enable native HTTPS listener
`server.tls_port`	`443`	HTTPS listener port
`server.tls_cert_file`	`""`	TLS cert path (auto-generated when empty)
`server.tls_key_file`	`""`	TLS key path (auto-generated when empty)
`server.gordon_domain`	`""`	Required - Gordon domain
`server.data_dir`	`~/.gordon`	Data directory
`server.max_blob_chunk_size`	`"512MB"`	Max size per registry blob upload chunk
`server.registry_allowed_ips`	`[]`	IPs or CIDR ranges allowed to access the registry (empty = allow all)
`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`	`"720h"`	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
`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
`auto_route.enabled`	`false`	Auto-route disabled
`network_isolation.enabled`	`false`	Isolation disabled
`network_isolation.network_prefix`	`"gordon"`	Network prefix
`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.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=8080
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 = 80                                    # HTTP proxy port
13registry_port = 5000                         # Container registry port
14tls_enabled = false                          # Enable native HTTPS listener
15tls_port = 443                               # HTTPS proxy port when enabled
16tls_cert_file = ""                           # PEM cert path (auto-generated if empty and TLS enabled)
17tls_key_file = ""                            # PEM key path (auto-generated if empty and TLS enabled)
18gordon_domain = ""                           # Required: Gordon domain (registry + API)
19data_dir = "~/.gordon"                       # Data directory (varies by install type)
20max_blob_chunk_size = "512MB"                # Max size per registry blob upload chunk
21registry_allowed_ips = []                    # IPs or CIDR ranges allowed to access the registry (empty = allow all)
22
23# =============================================================================
24# AUTHENTICATION (required - Gordon won't start without credentials configured)
25# =============================================================================
26[auth]
27enabled = true                               # Enable registry authentication (default: true)
28secrets_backend = "unsafe"                   # "pass", "sops", or "unsafe"
29token_secret = ""                            # Path in secrets backend to JWT signing key (REQUIRED)
30token_expiry = "720h"                        # Token expiry duration (720h = 30 days)
31access_token_ttl = "15m"                     # Ephemeral access token lifetime (default: 15m)
32
33# =============================================================================
34# API (applies to both Registry and Admin endpoints)
35# =============================================================================
36[api.rate_limit]
37enabled = true                               # Enable rate limiting (default: true)
38global_rps = 500                             # Max requests/second globally
39per_ip_rps = 50                              # Max requests/second per client IP
40burst = 100                                  # Burst size for rate limiters
41trusted_proxies = []                         # IPs/CIDRs trusted to set X-Forwarded-For
42
43# =============================================================================
44# LOGGING
45# =============================================================================
46[logging]
47level = "info"                               # "debug", "info", "warn", "error"
48format = "console"                           # "console" or "json"
49
50[logging.file]
51enabled = false                              # Enable file logging
52path = ""                                    # Log file path (default: {data_dir}/logs/gordon.log)
53max_size = 100                               # Max size in MB before rotation
54max_backups = 3                              # Number of old files to keep
55max_age = 28                                 # Days to keep old files
56
57[logging.container_logs]
58enabled = true                               # Enable container log collection
59dir = ""                                     # Log directory (default: {data_dir}/container-logs)
60max_size = 100                               # Max size in MB before rotation
61max_backups = 3                              # Number of old files to keep
62max_age = 28                                 # Days to keep old files
63
64# =============================================================================
65# TELEMETRY (OpenTelemetry)
66# =============================================================================
67[telemetry]
68enabled = false                              # Enable OTLP telemetry export
69endpoint = ""                                # OTLP HTTP endpoint URL
70auth_token = ""                              # Base64-encoded user:password for Basic auth
71traces = true                                # Export distributed traces
72metrics = true                               # Export metrics
73logs = true                                  # Bridge zerolog output to OTLP logs
74trace_sample_rate = 1.0                      # Fraction of traces to sample (0.0–1.0)
75
76# =============================================================================
77# ENVIRONMENT
78# =============================================================================
79[env]
80dir = ""                                     # Env files directory (default: {data_dir}/env)
81
82# =============================================================================
83# DEPLOYMENT
84# =============================================================================
85[deploy]
86pull_policy = "if-tag-changed"               # "always", "if-tag-changed", "never"
87readiness_mode = "auto"                      # "auto", "docker-health", "delay"
88health_timeout = "90s"                       # Max wait for health-based readiness
89readiness_delay = "5s"                       # Wait after running before considered ready
90drain_mode = "auto"                          # "auto", "inflight", "delay"
91drain_timeout = "30s"                        # Max wait for in-flight request drain
92drain_delay = "2s"                           # Wait after cache invalidation before old stop
93
94# =============================================================================
95# AUTO-ROUTE
96# =============================================================================
97[auto_route]
98enabled = false                              # Create routes from image labels automatically
99
100# =============================================================================
101# NETWORK ISOLATION
102# =============================================================================
103[network_isolation]
104enabled = false                              # Enable per-app Docker networks
105network_prefix = "gordon"                    # Prefix for created networks
106
107# =============================================================================
108# VOLUMES
109# =============================================================================
110[volumes]
111auto_create = true                           # Auto-create volumes from Dockerfile VOLUME
112prefix = "gordon"                            # Volume name prefix
113preserve = true                              # Keep volumes when containers are removed
114
115# =============================================================================
116# ROUTES
117# =============================================================================
118[routes]
119# "domain.com" = "image:tag"
120# "http://insecure.domain.com" = "image:tag"   # HTTP-only (no HTTPS redirect)
121
122# =============================================================================
123# EXTERNAL ROUTES
124# =============================================================================
125[external_routes]
126# "domain.com" = "host:port"                 # Proxy to non-container services
127
128# =============================================================================
129# NETWORK GROUPS
130# =============================================================================
131[network_groups]
132# "group-name" = ["domain1.com", "domain2.com"]
133
134# =============================================================================
135# ATTACHMENTS
136# =============================================================================
137[attachments]
138# "domain-or-group" = ["image1:tag", "image2:tag"]
139
140# =============================================================================
141# BACKUPS
142# =============================================================================
143[backups]
144enabled = false                              # Enable backup service
145schedule = "daily"                          # "hourly", "daily", "weekly", "monthly"
146storage_dir = ""                            # Backup root (default: {data_dir}/backups)
147
148[backups.retention]
149hourly = 0                                   # Keep N hourly backups per DB
150daily = 0                                    # Keep N daily backups per DB
151weekly = 0                                   # Keep N weekly backups per DB
152monthly = 0                                  # Keep N monthly backups per DB
153
154# =============================================================================
155# IMAGES
156# =============================================================================
157[images.prune]
158enabled = false                              # Enable scheduled image cleanup
159schedule = "daily"                          # "hourly", "daily", "weekly", "monthly"
160keep_last = 3                                # Keep N newest tags per repository
161
162# Note: retention values set to 0 keep no backups for that tier.
163# For practical defaults, consider setting daily = 7.
164```
165
166## Default Values Summary
167
168| Setting | Default | Description |
169|---------|---------|-------------|
170| `server.port` | `80` | HTTP proxy port |
171| `server.registry_port` | `5000` | Container registry port |
172| `server.tls_enabled` | `false` | Enable native HTTPS listener |
173| `server.tls_port` | `443` | HTTPS listener port |
174| `server.tls_cert_file` | `""` | TLS cert path (auto-generated when empty) |
175| `server.tls_key_file` | `""` | TLS key path (auto-generated when empty) |
176| `server.gordon_domain` | `""` | **Required** - Gordon domain |
177| `server.data_dir` | `~/.gordon` | Data directory |
178| `server.max_blob_chunk_size` | `"512MB"` | Max size per registry blob upload chunk |
179| `server.registry_allowed_ips` | `[]` | IPs or CIDR ranges allowed to access the registry (empty = allow all) |
180| `auth.enabled` | `true` | Enable authentication; when `false`, run local-only mode (loopback-only `/v2/*`, `/admin/*` disabled) |
181| `auth.secrets_backend` | `"unsafe"` | Secrets storage |
182| `auth.token_expiry` | `"720h"` | 30 days |
183| `auth.access_token_ttl` | `"15m"` | Ephemeral access token lifetime |
184| `api.rate_limit.enabled` | `true` | Enable rate limiting |
185| `api.rate_limit.global_rps` | `500` | Global requests/second |
186| `api.rate_limit.per_ip_rps` | `50` | Per-IP requests/second |
187| `api.rate_limit.burst` | `100` | Burst size |
188| `api.rate_limit.trusted_proxies` | `[]` | IPs/CIDRs trusted for X-Forwarded-For |
189| `logging.level` | `"info"` | Log level |
190| `logging.format` | `"console"` | Log format |
191| `logging.file.enabled` | `false` | File logging disabled |
192| `logging.file.max_size` | `100` | 100 MB |
193| `logging.file.max_backups` | `3` | Keep 3 old files |
194| `logging.file.max_age` | `28` | 28 days |
195| `logging.container_logs.enabled` | `true` | Container logs enabled |
196| `logging.container_logs.max_size` | `100` | 100 MB |
197| `logging.container_logs.max_backups` | `3` | Keep 3 old files |
198| `logging.container_logs.max_age` | `28` | 28 days |
199| `telemetry.enabled` | `false` | Enable OTLP telemetry export |
200| `telemetry.endpoint` | `""` | OTLP HTTP endpoint URL |
201| `telemetry.auth_token` | `""` | Base64 `user:password` for Basic auth |
202| `telemetry.traces` | `true` | Export distributed traces |
203| `telemetry.metrics` | `true` | Export metrics |
204| `telemetry.logs` | `true` | Bridge zerolog to OTLP logs |
205| `telemetry.trace_sample_rate` | `1.0` | Fraction of traces to sample (0.0–1.0) |
206| `deploy.pull_policy` | `"if-tag-changed"` | Pull on tag change |
207| `deploy.readiness_mode` | `"auto"` | Readiness strategy (`auto`, `docker-health`, `delay`) |
208| `deploy.health_timeout` | `"90s"` | Max wait for health-based readiness before deploy fails |
209| `deploy.readiness_delay` | `"5s"` | Delay before container is considered ready |
210| `deploy.drain_mode` | `"auto"` | Drain strategy (`auto`, `inflight`, `delay`) |
211| `deploy.drain_timeout` | `"30s"` | Max wait for in-flight request drain before old stop |
212| `deploy.drain_delay` | `"2s"` | Delay before stopping previous container after cache invalidation |
213| `auto_route.enabled` | `false` | Auto-route disabled |
214| `network_isolation.enabled` | `false` | Isolation disabled |
215| `network_isolation.network_prefix` | `"gordon"` | Network prefix |
216| `volumes.auto_create` | `true` | Auto-create volumes |
217| `volumes.prefix` | `"gordon"` | Volume prefix |
218| `volumes.preserve` | `true` | Keep volumes |
219| `backups.enabled` | `false` | Backup service disabled |
220| `backups.schedule` | `"daily"` | Backup scheduler preset |
221| `backups.storage_dir` | `""` | Uses `{server.data_dir}/backups` when empty |
222| `backups.retention.hourly` | `0` | Keep no hourly backups by default |
223| `backups.retention.daily` | `0` | Keep no daily backups by default (recommend `7`) |
224| `backups.retention.weekly` | `0` | Keep no weekly backups by default |
225| `backups.retention.monthly` | `0` | Keep no monthly backups by default |
226| `images.prune.enabled` | `false` | Scheduled image cleanup disabled |
227| `images.prune.schedule` | `"daily"` | Cleanup schedule preset |
228| `images.prune.keep_last` | `3` | Number of recent tags kept per repository |
229
230Note: for all `backups.retention.*` keys, `0` means keep no backups for that retention tier.
231
232## Environment Variables
233
234All configuration options can be set via environment variables using the pattern:
235
236```
237GORDON_<SECTION>_<KEY>=value
238```
239
240Examples:
241```bash
242GORDON_SERVER_PORT=8080
243GORDON_SERVER_GORDON_DOMAIN=gordon.example.com
244GORDON_AUTH_ENABLED=true
245GORDON_LOGGING_LEVEL=debug
246GORDON_NETWORK_ISOLATION_ENABLED=true
247```
248
249Nested keys use underscores:
250```bash
251GORDON_LOGGING_FILE_ENABLED=true
252GORDON_LOGGING_FILE_MAX_SIZE=200
253GORDON_LOGGING_CONTAINER_LOGS_ENABLED=false
254```
255
256### Security Environment Variables
257
258These special environment variables take priority over config file values:
259
260| Variable | Description |
261|----------|-------------|
262| `GORDON_AUTH_TOKEN_SECRET` | JWT signing secret (avoids storing secret on disk) |
263
264Example:
265```bash
266export GORDON_AUTH_TOKEN_SECRET="your-secure-32-char-secret-here"
267gordon serve
268```
269
270## Pull Policy Options
271
272| Value | Behavior |
273|-------|----------|
274| `"always"` | Always pull image before deploying |
275| `"if-tag-changed"` | Pull only if image tag differs from running container |
276| `"never"` | Never pull, use local image only |
277
278## Secrets Backend Options
279
280| Value | Description |
281|-------|-------------|
282| `"pass"` | Unix password manager (recommended for production) |
283| `"sops"` | Mozilla SOPS encrypted files |
284| `"unsafe"` | Plain text files (development only) |
285
286## Log Level Options
287
288| Value | Description |
289|-------|-------------|
290| `"debug"` | Verbose debugging information |
291| `"info"` | General operational information |
292| `"warn"` | Warning conditions |
293| `"error"` | Error conditions only |
294
295## Related
296
297- [Configuration Overview](./index.md)
298- [Authentication](./auth.md)
299- [Telemetry](./telemetry.md)
300- [Network Isolation](./network-isolation.md)
301- [Volumes](./volumes.md)
302- [Images](./images.md)

reference.md RawHistoryFolder