docs: clarify config is auto-generated on first start

commit: 620c0ba24f3f6ba6755591e4faa92140dbc2fcb8
author: brice · 9mo ago · 2026-01-12 21:58 UTC
committer: brice · 9mo ago · 2026-01-12 20:49 UTC
parent: dae054c
signature: unsigned

2 files · +12 -24

M README.md +10 -22


@@ -40,18 +40,18 @@ Build on your machine, push to deploy. Works from your laptop or CI.
40	40		### Installation
41	41
42	42		```bash
43		-	# Download from releases
	43	+	# Download and install
44	44		wget https://github.com/bnema/gordon/releases/latest/download/gordon_linux_amd64.tar.gz
45	45		tar -xzf gordon_linux_amd64.tar.gz
46	46		chmod +x gordon
47	47		sudo mv gordon /usr/local/bin/
48	48
49		-	# Create config
50		-	mkdir -p ~/.config/gordon
51		-	cp examples/minimal.toml ~/.config/gordon/gordon.toml
52		-	# Edit gordon.toml with your domain
	49	+	# Start Gordon (generates config on first run)
	50	+	gordon start
53	51		```
54	52
	53	+	Config is created at `~/.config/gordon/gordon.toml` on first start. Edit it to set your `registry_domain` and routes.
	54	+
55	55		Important: For a complete working setup including networking, firewall, and systemd service, follow the [detailed setup guide](#detailed-setup-guide-podman-rootless-mode) below.
56	56
57	57		## Core Concepts

@@ -261,26 +261,14 @@ sudo mv gordon /usr/local/bin/
261	261
262	262		### 5. Configure Gordon
263	263		```bash
264		-	# Create config directory and file
265		-	mkdir -p ~/.config/gordon
266		-	cat > ~/.config/gordon/gordon.toml <<EOF
267		-	[server]
268		-	port = 8080
269		-	registry_port = 5000
270		-	registry_domain = "registry.yourdomain.com"
271		-
272		-	[secrets]
273		-	backend = "unsafe" # Use "pass" or "sops" for production
	264	+	# Run once to generate config, then stop with Ctrl+C
	265	+	gordon start
274	266
275		-	[registry_auth]
276		-	enabled = false # Enable after testing
277		-
278		-	[routes]
279		-	"app.yourdomain.com" = "myapp:latest"
280		-	EOF
	267	+	# Edit the generated config
	268	+	nano ~/.config/gordon/gordon.toml
281	269		```
282	270
283		-	Data is stored in `~/.gordon/` (registry, env files, logs, secrets).
	271	+	Set your `registry_domain` and add routes. Data is stored in `~/.gordon/`.
284	272
285	273		### 6. Create Systemd Service
286	274		```bash

 ### Installation
 ```bash
-# Download from releases
+# Download and install
 wget https://github.com/bnema/gordon/releases/latest/download/gordon_linux_amd64.tar.gz
 tar -xzf gordon_linux_amd64.tar.gz
 chmod +x gordon
 sudo mv gordon /usr/local/bin/
-# Create config
+# Start Gordon (generates config on first run)
-mkdir -p ~/.config/gordon
+gordon start
-cp examples/minimal.toml ~/.config/gordon/gordon.toml
-# Edit gordon.toml with your domain
 ```
+Config is created at `~/.config/gordon/gordon.toml` on first start. Edit it to set your `registry_domain` and routes.
 **Important:** For a complete working setup including networking, firewall, and systemd service, follow the [detailed setup guide](#detailed-setup-guide-podman-rootless-mode) below.
 ## Core Concepts
 ### 5. Configure Gordon
 ```bash
-# Create config directory and file
+# Run once to generate config, then stop with Ctrl+C
-mkdir -p ~/.config/gordon
+gordon start
-cat > ~/.config/gordon/gordon.toml <<EOF
-[server]
-port = 8080
-registry_port = 5000
-registry_domain = "registry.yourdomain.com"
-[secrets]
-backend = "unsafe"  # Use "pass" or "sops" for production
-[registry_auth]
+# Edit the generated config
-enabled = false  # Enable after testing
+nano ~/.config/gordon/gordon.toml
-[routes]
-"app.yourdomain.com" = "myapp:latest"
-EOF
 ```
-Data is stored in `~/.gordon/` (registry, env files, logs, secrets).
+Set your `registry_domain` and add routes. Data is stored in `~/.gordon/`.
 ### 6. Create Systemd Service
 ```bash

M examples/README.md +2 -2

@@ -1,9 +1,9 @@
1	1		# Examples
2	2
3		-	Copy an example and edit:
	3	+	Config is auto-generated on first `gordon start`. Use these examples as reference or replace the generated config:
4	4
5	5		```bash
6		-	cp examples/minimal.toml ~/.config/gordon/gordon.toml
	6	+	cp examples/production.toml ~/.config/gordon/gordon.toml
7	7		```
8	8
9	9		## Configurations

@@ -1,9 +1,9 @@
1		# Examples	1		# Examples
2			2
3	-	Copy an example and edit:	3	+	Config is auto-generated on first `gordon start`. Use these examples as reference or replace the generated config:
4			4
5		```bash	5		```bash
6	-	cp examples/minimal.toml ~/.config/gordon/gordon.toml	6	+	cp examples/production.toml ~/.config/gordon/gordon.toml
7		```	7		```
8			8
9		## Configurations	9		## Configurations