v2.31.1 f37fe67

minimal.md RawHistoryFolder

Minimal Configuration

The simplest working Gordon configuration.

When to Use

  • Getting started with Gordon
  • Local development
  • Testing Gordon features

Configuration

# ~/.config/gordon/gordon.toml

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

# Authentication disabled for simplicity
[auth]
enabled = false

# Simple route
[routes]
"app.local" = "myapp:latest"

Setup

1. Add to /etc/hosts

echo "127.0.0.1 app.local gordon.local" | sudo tee -a /etc/hosts

2. Start Gordon

gordon serve

3. Build and Deploy

docker build -t myapp .
docker tag myapp gordon.local:5000/myapp:latest
docker push gordon.local:5000/myapp:latest

4. Access

Open http://app.local:8080

What's Included

Feature Enabled
Registry Yes
HTTP Proxy Yes
Authentication No
Logging Console only
Network Isolation No
Attachments No

What's Not Included

  • HTTPS (requires Cloudflare or similar)
  • Registry authentication
  • File-based logging
  • Network isolation
  • Service attachments

Next Steps

To add more features:

# Enable logging
[logging.file]
enabled = true
path = "~/.gordon/logs/gordon.log"

# Enable network isolation
[network_isolation]
enabled = true

# Add attachments
[attachments]
"app.local" = ["postgres:latest"]
source
1# Minimal Configuration
2
3The simplest working Gordon configuration.
4
5## When to Use
6
7- Getting started with Gordon
8- Local development
9- Testing Gordon features
10
11## Configuration
12
13```toml
14# ~/.config/gordon/gordon.toml
15
16[server]
17port = 8080
18registry_port = 5000
19gordon_domain = "gordon.local"
20
21# Authentication disabled for simplicity
22[auth]
23enabled = false
24
25# Simple route
26[routes]
27"app.local" = "myapp:latest"
28```
29
30## Setup
31
32### 1. Add to /etc/hosts
33
34```bash
35echo "127.0.0.1 app.local gordon.local" | sudo tee -a /etc/hosts
36```
37
38### 2. Start Gordon
39
40```bash
41gordon serve
42```
43
44### 3. Build and Deploy
45
46```bash
47docker build -t myapp .
48docker tag myapp gordon.local:5000/myapp:latest
49docker push gordon.local:5000/myapp:latest
50```
51
52### 4. Access
53
54Open http://app.local:8080
55
56## What's Included
57
58| Feature | Enabled |
59|---------|---------|
60| Registry | Yes |
61| HTTP Proxy | Yes |
62| Authentication | No |
63| Logging | Console only |
64| Network Isolation | No |
65| Attachments | No |
66
67## What's Not Included
68
69- HTTPS (requires Cloudflare or similar)
70- Registry authentication
71- File-based logging
72- Network isolation
73- Service attachments
74
75## Next Steps
76
77To add more features:
78
79```toml
80# Enable logging
81[logging.file]
82enabled = true
83path = "~/.gordon/logs/gordon.log"
84
85# Enable network isolation
86[network_isolation]
87enabled = true
88
89# Add attachments
90[attachments]
91"app.local" = ["postgres:latest"]
92```
93
94## Related
95
96- [Production Configuration](./production.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