index.md Raw History Folder

Configuration Overview

Gordon uses a single TOML configuration file located at ~/.config/gordon/gordon.toml.

Configuration File Location

Location	Purpose
`~/.config/gordon/gordon.toml`	Default configuration file
Custom path via `--config` flag	`gordon serve --config /path/to/config.toml`

Minimal Configuration

[server]
port = 8080
registry_port = 5000
gordon_domain = "gordon.mydomain.com"

[routes]
"app.mydomain.com" = "myapp:latest"

Note: gordon_domain is the canonical key. Migrate older registry_domain values before restarting.

Full Configuration Reference

For a complete list of all configuration options with their default values, see the Configuration Reference.

Note: This example shows production-style paths. Default paths use ~/.gordon/ for user installations.

# Server settings
[server]
port = 8088                              # HTTP proxy port (default: 8088)
registry_port = 5000                     # Registry port (default: 5000)
gordon_domain = "gordon.mydomain.com"    # Required: Gordon domain (registry + API)
# data_dir = "~/.gordon"                 # Default for user installations

# Authentication (includes secrets backend)
[auth]
enabled = true                           # Enable registry authentication (default: true)
secrets_backend = "pass"                 # "pass", "sops", or "unsafe"
token_secret = "gordon/auth/token_secret"  # Required: JWT signing secret
token_expiry = "30d"                     # Duration (1y, 30d, 2w) or 0 for never
# Token-only authentication (password login was removed in v2.30.0)

# API rate limiting
[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 IP
burst = 100                              # Burst size
trusted_proxies = []                     # IPs/CIDRs trusted for X-Forwarded-For

# Deploy behavior
[deploy]
pull_policy = "if-tag-changed"           # always, if-not-present, if-tag-changed
readiness_mode = "auto"                  # auto, docker-health, delay
health_timeout = "90s"                   # Max wait for health-based readiness
readiness_delay = "5s"                   # Wait after running before ready
drain_mode = "auto"                      # auto, inflight, delay
drain_timeout = "30s"                    # Max wait for in-flight drain
drain_delay = "2s"                       # Wait after proxy invalidation before stopping the old container

# Container runtime profile
[containers]
security_profile = "compat"              # compat or strict

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

[logging.file]
enabled = true
path = "~/.gordon/logs/gordon.log"       # Default location
max_size = 100                           # MB before rotation
max_backups = 3                          # Old files to keep
max_age = 28                             # Days to keep

[logging.container_logs]
enabled = true
dir = "~/.gordon/logs/containers"        # Default location
max_size = 100
max_backups = 3
max_age = 28

# Telemetry (OpenTelemetry)
[telemetry]
enabled = true                           # Enable OTLP export (default: false)
endpoint = "http://localhost:5080/api/default"  # OTLP HTTP endpoint
auth_token = ""                          # Base64 user:password for Basic auth
traces = true                            # Export traces
metrics = true                           # Export metrics
logs = true                              # Bridge zerolog to OTLP logs
trace_sample_rate = 1.0                  # 0.0 = none, 1.0 = all

# Environment variables
[env]
dir = "~/.gordon/env"                    # Default location

# Volume settings
[volumes]
auto_create = true                       # Auto-create from Dockerfile VOLUME
prefix = "gordon"                        # Volume name prefix
preserve = true                          # Keep volumes on container removal

# Network isolation
[network_isolation]
enabled = true                           # Per-app isolated networks
network_prefix = "gordon"                # Network name prefix
internal = false                          # Set true to block direct egress from isolated networks

# Auto-route
[auto_route]
enabled = false                          # Auto-create routes from image names

# Routes (required)
[routes]
"app.mydomain.com" = "myapp:latest"
"api.mydomain.com" = "myapi:v2.1.0"

# Network groups
[network_groups]
"backend" = ["app.mydomain.com", "api.mydomain.com"]

# Attachments
[attachments]
"app.mydomain.com" = ["postgres:latest", "redis:latest"]
"backend" = ["rabbitmq:latest"]

# Backups
[backups]
enabled = true
schedule = "daily"                        # "hourly", "daily", "weekly", "monthly"
storage_dir = "~/.gordon/backups"

[backups.retention]
hourly = 24
daily = 7
weekly = 4
monthly = 12

# Images
[images]
allowed_registries = []                   # Explicit external registries allowed for deploy/attachments
require_digest = false                    # Require digests for allowlisted external registries

[images.prune]
enabled = false
schedule = "daily"
keep_last = 3

Configuration Sections

Section	Description	Documentation
`[server]`	Core server settings	Server
`[auth]`	Authentication and secrets backend	Auth
`[api.rate_limit]`	Rate limiting configuration	Rate Limiting
`[deploy]`	Deployment behavior	Deploy
`[logging]`	Logging configuration	Logging
`[telemetry]`	OpenTelemetry observability export	Telemetry
`[env]`	Environment variable settings	Environment
`[volumes]`	Volume management	Volumes
`[network_isolation]`	Network isolation settings	Network Isolation
`[auto_route]`	Automatic route creation	Auto Route
`[routes]`	Domain to image mapping	Routes
`[external_routes]`	Non-containerized service proxying	External Routes
`[network_groups]`	Shared service networks	Network Groups
`[attachments]`	Service dependencies	Attachments
`[backups]`	Database backups	Backups
`[images.prune]`	Scheduled image cleanup	Images
Security hardening	Security controls and recommended knobs	Security Hardening

Default Values

Setting	Default
`server.port`	`8088`
`server.registry_port`	`5000`
`server.data_dir`	`~/.gordon`
`server.max_blob_chunk_size`	`"95MB"`
`server.max_blob_size`	`"1GB"`
`auth.enabled`	`true`
`auth.secrets_backend`	`"unsafe"`
`auth.token_expiry`	`"30d"`
`api.rate_limit.enabled`	`true`
`api.rate_limit.global_rps`	`500`
`api.rate_limit.per_ip_rps`	`50`
`api.rate_limit.burst`	`100`
`api.rate_limit.trusted_proxies`	`[]`
`deploy.pull_policy`	`"if-tag-changed"`
`deploy.readiness_mode`	`"auto"`
`deploy.health_timeout`	`"90s"`
`deploy.readiness_delay`	`"5s"`
`deploy.drain_mode`	`"auto"`
`deploy.drain_timeout`	`"30s"`
`deploy.drain_delay`	`"2s"`
`containers.security_profile`	`"compat"`
`logging.level`	`"info"`
`logging.format`	`"console"`
`logging.file.enabled`	`false`
`logging.file.max_size`	`100`
`logging.file.max_backups`	`3`
`logging.file.max_age`	`28`
`logging.container_logs.enabled`	`true`
`volumes.auto_create`	`true`
`volumes.prefix`	`"gordon"`
`volumes.preserve`	`true`
`network_isolation.enabled`	`true`
`network_isolation.internal`	`false`
`auto_route.enabled`	`false`
`backups.enabled`	`false`
`backups.schedule`	`"daily"` (`"hourly"`, `"daily"`, `"weekly"`, `"monthly"`)
`images.allowed_registries`	`[]`
`images.require_digest`	`false`
`images.prune.enabled`	`false`
`images.prune.schedule`	`"daily"`
`images.prune.keep_last`	`3`
`telemetry.enabled`	`false`
`telemetry.endpoint`	`""`
`telemetry.auth_token`	`""`
`telemetry.traces`	`true`
`telemetry.metrics`	`true`
`telemetry.logs`	`true`
`telemetry.trace_sample_rate`	`1.0`

When auth.enabled=false, Gordon runs in local-only mode: /admin/* is disabled and /v2/* is loopback-only.

Hot Reload

Gordon watches the configuration file and reloads automatically when changes are detected. You can also trigger a manual reload:

gordon reload

Hot-reloaded (no restart needed)

Setting
`server.gordon_domain` (registry domain)
`server.registry_port`
`server.max_proxy_body_size`
`server.max_proxy_response_size`
`server.max_concurrent_conns`

Note: Routes are hot-reloaded from the config file. You can still use the API or CLI (gordon routes add/update/remove) for live route changes.

Requires restart

Setting
`server.port`
`server.data_dir`
`server.max_blob_chunk_size`
`server.max_blob_size`
`auth.*`
`deploy.readiness_mode`
`deploy.readiness_delay`
`deploy.health_timeout`
`deploy.drain_mode`
`deploy.drain_timeout`

Environment Variable Override

Configuration values can be overridden with environment variables:

GORDON_SERVER_PORT=8080 gordon serve
GORDON_LOGGING_LEVEL=debug gordon serve

Pattern: GORDON_SECTION_KEY (uppercase, underscores instead of dots)

source

1# Configuration Overview
2
3Gordon uses a single TOML configuration file located at `~/.config/gordon/gordon.toml`.
4
5## Configuration File Location
6
7| Location | Purpose |
8|----------|---------|
9| `~/.config/gordon/gordon.toml` | Default configuration file |
10| Custom path via `--config` flag | `gordon serve --config /path/to/config.toml` |
11
12## Minimal Configuration
13
14```toml
15[server]
16port = 8080
17registry_port = 5000
18gordon_domain = "gordon.mydomain.com"
19
20[routes]
21"app.mydomain.com" = "myapp:latest"
22```
23
24> **Note:** `gordon_domain` is the canonical key. Migrate older `registry_domain` values before restarting.
25
26## Full Configuration Reference
27
28For a complete list of all configuration options with their default values, see the [Configuration Reference](./reference.md).
29
30> **Note:** This example shows production-style paths. Default paths use `~/.gordon/` for user installations.
31
32```toml
33# Server settings
34[server]
35port = 8088                              # HTTP proxy port (default: 8088)
36registry_port = 5000                     # Registry port (default: 5000)
37gordon_domain = "gordon.mydomain.com"    # Required: Gordon domain (registry + API)
38# data_dir = "~/.gordon"                 # Default for user installations
39
40# Authentication (includes secrets backend)
41[auth]
42enabled = true                           # Enable registry authentication (default: true)
43secrets_backend = "pass"                 # "pass", "sops", or "unsafe"
44token_secret = "gordon/auth/token_secret"  # Required: JWT signing secret
45token_expiry = "30d"                     # Duration (1y, 30d, 2w) or 0 for never
46# Token-only authentication (password login was removed in v2.30.0)
47
48# API rate limiting
49[api.rate_limit]
50enabled = true                           # Enable rate limiting (default: true)
51global_rps = 500                         # Max requests/second globally
52per_ip_rps = 50                          # Max requests/second per IP
53burst = 100                              # Burst size
54trusted_proxies = []                     # IPs/CIDRs trusted for X-Forwarded-For
55
56# Deploy behavior
57[deploy]
58pull_policy = "if-tag-changed"           # always, if-not-present, if-tag-changed
59readiness_mode = "auto"                  # auto, docker-health, delay
60health_timeout = "90s"                   # Max wait for health-based readiness
61readiness_delay = "5s"                   # Wait after running before ready
62drain_mode = "auto"                      # auto, inflight, delay
63drain_timeout = "30s"                    # Max wait for in-flight drain
64drain_delay = "2s"                       # Wait after proxy invalidation before stopping the old container
65
66# Container runtime profile
67[containers]
68security_profile = "compat"              # compat or strict
69
70# Logging
71[logging]
72level = "info"                           # trace, debug, info, warn, error
73format = "console"                       # console or json
74
75[logging.file]
76enabled = true
77path = "~/.gordon/logs/gordon.log"       # Default location
78max_size = 100                           # MB before rotation
79max_backups = 3                          # Old files to keep
80max_age = 28                             # Days to keep
81
82[logging.container_logs]
83enabled = true
84dir = "~/.gordon/logs/containers"        # Default location
85max_size = 100
86max_backups = 3
87max_age = 28
88
89# Telemetry (OpenTelemetry)
90[telemetry]
91enabled = true                           # Enable OTLP export (default: false)
92endpoint = "http://localhost:5080/api/default"  # OTLP HTTP endpoint
93auth_token = ""                          # Base64 user:password for Basic auth
94traces = true                            # Export traces
95metrics = true                           # Export metrics
96logs = true                              # Bridge zerolog to OTLP logs
97trace_sample_rate = 1.0                  # 0.0 = none, 1.0 = all
98
99# Environment variables
100[env]
101dir = "~/.gordon/env"                    # Default location
102
103# Volume settings
104[volumes]
105auto_create = true                       # Auto-create from Dockerfile VOLUME
106prefix = "gordon"                        # Volume name prefix
107preserve = true                          # Keep volumes on container removal
108
109# Network isolation
110[network_isolation]
111enabled = true                           # Per-app isolated networks
112network_prefix = "gordon"                # Network name prefix
113internal = false                          # Set true to block direct egress from isolated networks
114
115# Auto-route
116[auto_route]
117enabled = false                          # Auto-create routes from image names
118
119# Routes (required)
120[routes]
121"app.mydomain.com" = "myapp:latest"
122"api.mydomain.com" = "myapi:v2.1.0"
123
124# Network groups
125[network_groups]
126"backend" = ["app.mydomain.com", "api.mydomain.com"]
127
128# Attachments
129[attachments]
130"app.mydomain.com" = ["postgres:latest", "redis:latest"]
131"backend" = ["rabbitmq:latest"]
132
133# Backups
134[backups]
135enabled = true
136schedule = "daily"                        # "hourly", "daily", "weekly", "monthly"
137storage_dir = "~/.gordon/backups"
138
139[backups.retention]
140hourly = 24
141daily = 7
142weekly = 4
143monthly = 12
144
145# Images
146[images]
147allowed_registries = []                   # Explicit external registries allowed for deploy/attachments
148require_digest = false                    # Require digests for allowlisted external registries
149
150[images.prune]
151enabled = false
152schedule = "daily"
153keep_last = 3
154```
155
156## Configuration Sections
157
158| Section | Description | Documentation |
159|---------|-------------|---------------|
160| `[server]` | Core server settings | [Server](./server.md) |
161| `[auth]` | Authentication and secrets backend | [Auth](./auth.md) |
162| `[api.rate_limit]` | Rate limiting configuration | [Rate Limiting](./rate-limiting.md) |
163| `[deploy]` | Deployment behavior | [Deploy](./deploy.md) |
164| `[logging]` | Logging configuration | [Logging](./logging.md) |
165| `[telemetry]` | OpenTelemetry observability export | [Telemetry](./telemetry.md) |
166| `[env]` | Environment variable settings | [Environment](./env.md) |
167| `[volumes]` | Volume management | [Volumes](./volumes.md) |
168| `[network_isolation]` | Network isolation settings | [Network Isolation](./network-isolation.md) |
169| `[auto_route]` | Automatic route creation | [Auto Route](./auto-route.md) |
170| `[routes]` | Domain to image mapping | [Routes](./routes.md) |
171| `[external_routes]` | Non-containerized service proxying | [External Routes](./external-routes.md) |
172| `[network_groups]` | Shared service networks | [Network Groups](./network-groups.md) |
173| `[attachments]` | Service dependencies | [Attachments](./attachments.md) |
174| `[backups]` | Database backups | [Backups](./backups.md) |
175| `[images.prune]` | Scheduled image cleanup | [Images](./images.md) |
176| Security hardening | Security controls and recommended knobs | [Security Hardening](./security-hardening.md) |
177
178## Default Values
179
180| Setting | Default |
181|---------|---------|
182| `server.port` | `8088` |
183| `server.registry_port` | `5000` |
184| `server.data_dir` | `~/.gordon` |
185| `server.max_blob_chunk_size` | `"95MB"` |
186| `server.max_blob_size` | `"1GB"` |
187| `auth.enabled` | `true` |
188| `auth.secrets_backend` | `"unsafe"` |
189| `auth.token_expiry` | `"30d"` |
190| `api.rate_limit.enabled` | `true` |
191| `api.rate_limit.global_rps` | `500` |
192| `api.rate_limit.per_ip_rps` | `50` |
193| `api.rate_limit.burst` | `100` |
194| `api.rate_limit.trusted_proxies` | `[]` |
195| `deploy.pull_policy` | `"if-tag-changed"` |
196| `deploy.readiness_mode` | `"auto"` |
197| `deploy.health_timeout` | `"90s"` |
198| `deploy.readiness_delay` | `"5s"` |
199| `deploy.drain_mode` | `"auto"` |
200| `deploy.drain_timeout` | `"30s"` |
201| `deploy.drain_delay` | `"2s"` |
202| `containers.security_profile` | `"compat"` |
203| `logging.level` | `"info"` |
204| `logging.format` | `"console"` |
205| `logging.file.enabled` | `false` |
206| `logging.file.max_size` | `100` |
207| `logging.file.max_backups` | `3` |
208| `logging.file.max_age` | `28` |
209| `logging.container_logs.enabled` | `true` |
210| `volumes.auto_create` | `true` |
211| `volumes.prefix` | `"gordon"` |
212| `volumes.preserve` | `true` |
213| `network_isolation.enabled` | `true` |
214| `network_isolation.internal` | `false` |
215| `auto_route.enabled` | `false` |
216| `backups.enabled` | `false` |
217| `backups.schedule` | `"daily"` (`"hourly"`, `"daily"`, `"weekly"`, `"monthly"`) |
218| `images.allowed_registries` | `[]` |
219| `images.require_digest` | `false` |
220| `images.prune.enabled` | `false` |
221| `images.prune.schedule` | `"daily"` |
222| `images.prune.keep_last` | `3` |
223| `telemetry.enabled` | `false` |
224| `telemetry.endpoint` | `""` |
225| `telemetry.auth_token` | `""` |
226| `telemetry.traces` | `true` |
227| `telemetry.metrics` | `true` |
228| `telemetry.logs` | `true` |
229| `telemetry.trace_sample_rate` | `1.0` |
230
231When `auth.enabled=false`, Gordon runs in local-only mode: `/admin/*` is disabled and `/v2/*` is loopback-only.
232
233## Hot Reload
234
235Gordon watches the configuration file and reloads automatically when changes are detected. You can also trigger a manual reload:
236
237```bash
238gordon reload
239```
240
241### Hot-reloaded (no restart needed)
242
243| Setting |
244|---------|
245| `server.gordon_domain` (registry domain) |
246| `server.registry_port` |
247| `server.max_proxy_body_size` |
248| `server.max_proxy_response_size` |
249| `server.max_concurrent_conns` |
250
251> **Note:** Routes are hot-reloaded from the config file. You can still use the API or CLI (`gordon routes add/update/remove`) for live route changes.
252
253### Requires restart
254
255| Setting |
256|---------|
257| `server.port` |
258| `server.data_dir` |
259| `server.max_blob_chunk_size` |
260| `server.max_blob_size` |
261| `auth.*` |
262| `deploy.readiness_mode` |
263| `deploy.readiness_delay` |
264| `deploy.health_timeout` |
265| `deploy.drain_mode` |
266| `deploy.drain_timeout` |
267
268## Environment Variable Override
269
270Configuration values can be overridden with environment variables:
271
272```bash
273GORDON_SERVER_PORT=8080 gordon serve
274GORDON_LOGGING_LEVEL=debug gordon serve
275```
276
277Pattern: `GORDON_SECTION_KEY` (uppercase, underscores instead of dots)
278
279## Related
280
281- [Server Configuration](./server.md)
282- [Routes Configuration](./routes.md)
283- [External Routes](./external-routes.md)
284- [Authentication](./auth.md)
285- [Telemetry](./telemetry.md)
286- [Backups](./backups.md)
287- [Images](./images.md)

index.md RawHistoryFolder