v2.30.1 1983e1b

reference.md RawHistoryFolder

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)
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)
force_hsts = false                           # Always send HSTS header (enable when behind TLS-terminating proxy)

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

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 7

Tags 106

↑↓ moveenter openesc close