docs: rename start command to serve
- commit
- e4becedfc14bbe124183696fcc8d5db2b36ec720
- author
- bnema · · 2026-01-16 20:48 UTC
- parent
- 3153d5c
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
7 files · +22 -22
M README.md +1 -1
| @@ -48,7 +48,7 @@ curl -fsSL https://gordon.bnema.dev/install.sh | sh | |||
| 48 | 48 | # Or: curl -fsSL https://raw.githubusercontent.com/bnema/gordon/main/install.sh | sh | |
| 49 | 49 | ||
| 50 | 50 | # Start Gordon (generates config on first run) | |
| 51 | - | gordon start | |
| 51 | + | gordon serve | |
| 52 | 52 | ``` | |
| 53 | 53 | ||
| 54 | 54 | Config is created at `~/.config/gordon/gordon.toml`. See the [Getting Started guide](https://gordon.bnema.dev/docs/getting-started) for complete setup instructions. | |
| @@ -48,7 +48,7 @@ curl -fsSL https://gordon.bnema.dev/install.sh | sh | |||||
| 48 | # Or: curl -fsSL https://raw.githubusercontent.com/bnema/gordon/main/install.sh | sh | 48 | # Or: curl -fsSL https://raw.githubusercontent.com/bnema/gordon/main/install.sh | sh | ||
| 49 | 49 | ||||
| 50 | # Start Gordon (generates config on first run) | 50 | # Start Gordon (generates config on first run) | ||
| 51 | - | gordon start | 51 | + | gordon serve |
| 52 | ``` | 52 | ``` | ||
| 53 | 53 | ||||
| 54 | Config is created at `~/.config/gordon/gordon.toml`. See the [Getting Started guide](https://gordon.bnema.dev/docs/getting-started) for complete setup instructions. | 54 | Config is created at `~/.config/gordon/gordon.toml`. See the [Getting Started guide](https://gordon.bnema.dev/docs/getting-started) for complete setup instructions. | ||
M docs/cli/commands.md +12 -12
| @@ -6,7 +6,7 @@ Gordon provides a command-line interface for server management, deployment, and | |||
| 6 | 6 | ||
| 7 | 7 | | Command | Description | | |
| 8 | 8 | |---------|-------------| | |
| 9 | - | | `gordon start` | Start the Gordon server | | |
| 9 | + | | `gordon serve` | Start the Gordon server | | |
| 10 | 10 | | `gordon reload` | Reload configuration and sync containers | | |
| 11 | 11 | | `gordon deploy` | Manually deploy or redeploy a specific route | | |
| 12 | 12 | | `gordon logs` | Display Gordon process logs | | |
| @@ -17,8 +17,8 @@ Gordon provides a command-line interface for server management, deployment, and | |||
| 17 | 17 | ||
| 18 | 18 | ```bash | |
| 19 | 19 | # Start Gordon | |
| 20 | - | gordon start | |
| 21 | - | gordon start --config /path/to/config.toml | |
| 20 | + | gordon serve | |
| 21 | + | gordon serve --config /path/to/config.toml | |
| 22 | 22 | ||
| 23 | 23 | # Reload configuration | |
| 24 | 24 | gordon reload | |
| @@ -50,14 +50,14 @@ gordon auth internal | |||
| 50 | 50 | ||
| 51 | 51 | --- | |
| 52 | 52 | ||
| 53 | - | ## gordon start | |
| 53 | + | ## gordon serve | |
| 54 | 54 | ||
| 55 | 55 | Start the Gordon server with registry and proxy components. | |
| 56 | 56 | ||
| 57 | 57 | ### Synopsis | |
| 58 | 58 | ||
| 59 | 59 | ```bash | |
| 60 | - | gordon start [options] | |
| 60 | + | gordon serve [options] | |
| 61 | 61 | ``` | |
| 62 | 62 | ||
| 63 | 63 | ### Options | |
| @@ -90,7 +90,7 @@ On first run without a config file, Gordon creates a default configuration at `~ | |||
| 90 | 90 | ||
| 91 | 91 | ```bash | |
| 92 | 92 | # First run - creates default config | |
| 93 | - | gordon start | |
| 93 | + | gordon serve | |
| 94 | 94 | # Edit the config, then restart | |
| 95 | 95 | ``` | |
| 96 | 96 | ||
| @@ -98,15 +98,15 @@ gordon start | |||
| 98 | 98 | ||
| 99 | 99 | ```bash | |
| 100 | 100 | # Basic start | |
| 101 | - | gordon start | |
| 101 | + | gordon serve | |
| 102 | 102 | ||
| 103 | 103 | # With custom config | |
| 104 | - | gordon start --config /path/to/gordon.toml | |
| 105 | - | gordon start -c ./my-config.toml | |
| 104 | + | gordon serve --config /path/to/gordon.toml | |
| 105 | + | gordon serve -c ./my-config.toml | |
| 106 | 106 | ||
| 107 | 107 | # With environment override | |
| 108 | - | GORDON_SERVER_PORT=8080 gordon start | |
| 109 | - | GORDON_LOGGING_LEVEL=debug gordon start | |
| 108 | + | GORDON_SERVER_PORT=8080 gordon serve | |
| 109 | + | GORDON_LOGGING_LEVEL=debug gordon serve | |
| 110 | 110 | ``` | |
| 111 | 111 | ||
| 112 | 112 | ### Signals | |
| @@ -132,7 +132,7 @@ Description=Gordon Container Platform | |||
| 132 | 132 | [Service] | |
| 133 | 133 | Type=simple | |
| 134 | 134 | Restart=always | |
| 135 | - | ExecStart=/usr/local/bin/gordon start | |
| 135 | + | ExecStart=/usr/local/bin/gordon serve | |
| 136 | 136 | ||
| 137 | 137 | [Install] | |
| 138 | 138 | WantedBy=default.target | |
| @@ -6,7 +6,7 @@ Gordon provides a command-line interface for server management, deployment, and | |||||
| 6 | 6 | ||||
| 7 | | Command | Description | | 7 | | Command | Description | | ||
| 8 | |---------|-------------| | 8 | |---------|-------------| | ||
| 9 | - | | `gordon start` | Start the Gordon server | | 9 | + | | `gordon serve` | Start the Gordon server | |
| 10 | | `gordon reload` | Reload configuration and sync containers | | 10 | | `gordon reload` | Reload configuration and sync containers | | ||
| 11 | | `gordon deploy` | Manually deploy or redeploy a specific route | | 11 | | `gordon deploy` | Manually deploy or redeploy a specific route | | ||
| 12 | | `gordon logs` | Display Gordon process logs | | 12 | | `gordon logs` | Display Gordon process logs | | ||
| @@ -17,8 +17,8 @@ Gordon provides a command-line interface for server management, deployment, and | |||||
| 17 | 17 | ||||
| 18 | ```bash | 18 | ```bash | ||
| 19 | # Start Gordon | 19 | # Start Gordon | ||
| 20 | - | gordon start | 20 | + | gordon serve |
| 21 | - | gordon start --config /path/to/config.toml | 21 | + | gordon serve --config /path/to/config.toml |
| 22 | 22 | ||||
| 23 | # Reload configuration | 23 | # Reload configuration | ||
| 24 | gordon reload | 24 | gordon reload | ||
| @@ -50,14 +50,14 @@ gordon auth internal | |||||
| 50 | 50 | ||||
| 51 | --- | 51 | --- | ||
| 52 | 52 | ||||
| 53 | - | ## gordon start | 53 | + | ## gordon serve |
| 54 | 54 | ||||
| 55 | Start the Gordon server with registry and proxy components. | 55 | Start the Gordon server with registry and proxy components. | ||
| 56 | 56 | ||||
| 57 | ### Synopsis | 57 | ### Synopsis | ||
| 58 | 58 | ||||
| 59 | ```bash | 59 | ```bash | ||
| 60 | - | gordon start [options] | 60 | + | gordon serve [options] |
| 61 | ``` | 61 | ``` | ||
| 62 | 62 | ||||
| 63 | ### Options | 63 | ### Options | ||
| @@ -90,7 +90,7 @@ On first run without a config file, Gordon creates a default configuration at `~ | |||||
| 90 | 90 | ||||
| 91 | ```bash | 91 | ```bash | ||
| 92 | # First run - creates default config | 92 | # First run - creates default config | ||
| 93 | - | gordon start | 93 | + | gordon serve |
| 94 | # Edit the config, then restart | 94 | # Edit the config, then restart | ||
| 95 | ``` | 95 | ``` | ||
| 96 | 96 | ||||
| @@ -98,15 +98,15 @@ gordon start | |||||
| 98 | 98 | ||||
| 99 | ```bash | 99 | ```bash | ||
| 100 | # Basic start | 100 | # Basic start | ||
| 101 | - | gordon start | 101 | + | gordon serve |
| 102 | 102 | ||||
| 103 | # With custom config | 103 | # With custom config | ||
| 104 | - | gordon start --config /path/to/gordon.toml | 104 | + | gordon serve --config /path/to/gordon.toml |
| 105 | - | gordon start -c ./my-config.toml | 105 | + | gordon serve -c ./my-config.toml |
| 106 | 106 | ||||
| 107 | # With environment override | 107 | # With environment override | ||
| 108 | - | GORDON_SERVER_PORT=8080 gordon start | 108 | + | GORDON_SERVER_PORT=8080 gordon serve |
| 109 | - | GORDON_LOGGING_LEVEL=debug gordon start | 109 | + | GORDON_LOGGING_LEVEL=debug gordon serve |
| 110 | ``` | 110 | ``` | ||
| 111 | 111 | ||||
| 112 | ### Signals | 112 | ### Signals | ||
| @@ -132,7 +132,7 @@ Description=Gordon Container Platform | |||||
| 132 | [Service] | 132 | [Service] | ||
| 133 | Type=simple | 133 | Type=simple | ||
| 134 | Restart=always | 134 | Restart=always | ||
| 135 | - | ExecStart=/usr/local/bin/gordon start | 135 | + | ExecStart=/usr/local/bin/gordon serve |
| 136 | 136 | ||||
| 137 | [Install] | 137 | [Install] | ||
| 138 | WantedBy=default.target | 138 | WantedBy=default.target | ||
M docs/getting-started.md +2 -2
| @@ -20,7 +20,7 @@ This script automatically detects your OS and architecture, downloads the approp | |||
| 20 | 20 | ||
| 21 | 21 | ```bash | |
| 22 | 22 | # First run creates the default config | |
| 23 | - | gordon start | |
| 23 | + | gordon serve | |
| 24 | 24 | # Press Ctrl+C to stop | |
| 25 | 25 | ``` | |
| 26 | 26 | ||
| @@ -63,7 +63,7 @@ Description=Gordon Container Platform | |||
| 63 | 63 | [Service] | |
| 64 | 64 | Type=simple | |
| 65 | 65 | Restart=always | |
| 66 | - | ExecStart=/usr/local/bin/gordon start | |
| 66 | + | ExecStart=/usr/local/bin/gordon serve | |
| 67 | 67 | ||
| 68 | 68 | [Install] | |
| 69 | 69 | WantedBy=default.target | |
| @@ -20,7 +20,7 @@ This script automatically detects your OS and architecture, downloads the approp | |||||
| 20 | 20 | ||||
| 21 | ```bash | 21 | ```bash | ||
| 22 | # First run creates the default config | 22 | # First run creates the default config | ||
| 23 | - | gordon start | 23 | + | gordon serve |
| 24 | # Press Ctrl+C to stop | 24 | # Press Ctrl+C to stop | ||
| 25 | ``` | 25 | ``` | ||
| 26 | 26 | ||||
| @@ -63,7 +63,7 @@ Description=Gordon Container Platform | |||||
| 63 | [Service] | 63 | [Service] | ||
| 64 | Type=simple | 64 | Type=simple | ||
| 65 | Restart=always | 65 | Restart=always | ||
| 66 | - | ExecStart=/usr/local/bin/gordon start | 66 | + | ExecStart=/usr/local/bin/gordon serve |
| 67 | 67 | ||||
| 68 | [Install] | 68 | [Install] | ||
| 69 | WantedBy=default.target | 69 | WantedBy=default.target | ||
M docs/installation.md +3 -3
| @@ -153,7 +153,7 @@ Gordon creates a default configuration on first run: | |||
| 153 | 153 | ||
| 154 | 154 | ```bash | |
| 155 | 155 | # Run once to generate config, then stop | |
| 156 | - | gordon start | |
| 156 | + | gordon serve | |
| 157 | 157 | # Press Ctrl+C | |
| 158 | 158 | ||
| 159 | 159 | # Edit configuration | |
| @@ -189,7 +189,7 @@ After=podman.socket | |||
| 189 | 189 | Type=simple | |
| 190 | 190 | Restart=always | |
| 191 | 191 | RestartSec=5 | |
| 192 | - | ExecStart=/usr/local/bin/gordon start | |
| 192 | + | ExecStart=/usr/local/bin/gordon serve | |
| 193 | 193 | ||
| 194 | 194 | [Install] | |
| 195 | 195 | WantedBy=default.target | |
| @@ -219,7 +219,7 @@ Requires=docker.service | |||
| 219 | 219 | Type=simple | |
| 220 | 220 | Restart=always | |
| 221 | 221 | RestartSec=5 | |
| 222 | - | ExecStart=/usr/local/bin/gordon start | |
| 222 | + | ExecStart=/usr/local/bin/gordon serve | |
| 223 | 223 | User=root | |
| 224 | 224 | ||
| 225 | 225 | [Install] | |
| @@ -153,7 +153,7 @@ Gordon creates a default configuration on first run: | |||||
| 153 | 153 | ||||
| 154 | ```bash | 154 | ```bash | ||
| 155 | # Run once to generate config, then stop | 155 | # Run once to generate config, then stop | ||
| 156 | - | gordon start | 156 | + | gordon serve |
| 157 | # Press Ctrl+C | 157 | # Press Ctrl+C | ||
| 158 | 158 | ||||
| 159 | # Edit configuration | 159 | # Edit configuration | ||
| @@ -189,7 +189,7 @@ After=podman.socket | |||||
| 189 | Type=simple | 189 | Type=simple | ||
| 190 | Restart=always | 190 | Restart=always | ||
| 191 | RestartSec=5 | 191 | RestartSec=5 | ||
| 192 | - | ExecStart=/usr/local/bin/gordon start | 192 | + | ExecStart=/usr/local/bin/gordon serve |
| 193 | 193 | ||||
| 194 | [Install] | 194 | [Install] | ||
| 195 | WantedBy=default.target | 195 | WantedBy=default.target | ||
| @@ -219,7 +219,7 @@ Requires=docker.service | |||||
| 219 | Type=simple | 219 | Type=simple | ||
| 220 | Restart=always | 220 | Restart=always | ||
| 221 | RestartSec=5 | 221 | RestartSec=5 | ||
| 222 | - | ExecStart=/usr/local/bin/gordon start | 222 | + | ExecStart=/usr/local/bin/gordon serve |
| 223 | User=root | 223 | User=root | ||
| 224 | 224 | ||||
| 225 | [Install] | 225 | [Install] | ||
M docs/reference/troubleshooting.md +1 -1
| @@ -35,7 +35,7 @@ Common issues and solutions when using Gordon. | |||
| 35 | 35 | ```bash | |
| 36 | 36 | systemctl --user status gordon | |
| 37 | 37 | # or | |
| 38 | - | pgrep -f "gordon start" | |
| 38 | + | pgrep -f "gordon serve" | |
| 39 | 39 | ``` | |
| 40 | 40 | ||
| 41 | 41 | 2. Check registry port is accessible: | |
| @@ -35,7 +35,7 @@ Common issues and solutions when using Gordon. | |||||
| 35 | ```bash | 35 | ```bash | ||
| 36 | systemctl --user status gordon | 36 | systemctl --user status gordon | ||
| 37 | # or | 37 | # or | ||
| 38 | - | pgrep -f "gordon start" | 38 | + | pgrep -f "gordon serve" |
| 39 | ``` | 39 | ``` | ||
| 40 | 40 | ||||
| 41 | 2. Check registry port is accessible: | 41 | 2. Check registry port is accessible: | ||
M wiki/examples/minimal.md +1 -1
| @@ -38,7 +38,7 @@ echo "127.0.0.1 app.local registry.local" | sudo tee -a /etc/hosts | |||
| 38 | 38 | ### 2. Start Gordon | |
| 39 | 39 | ||
| 40 | 40 | ```bash | |
| 41 | - | gordon start | |
| 41 | + | gordon serve | |
| 42 | 42 | ``` | |
| 43 | 43 | ||
| 44 | 44 | ### 3. Build and Deploy | |
| @@ -38,7 +38,7 @@ echo "127.0.0.1 app.local registry.local" | sudo tee -a /etc/hosts | |||||
| 38 | ### 2. Start Gordon | 38 | ### 2. Start Gordon | ||
| 39 | 39 | ||||
| 40 | ```bash | 40 | ```bash | ||
| 41 | - | gordon start | 41 | + | gordon serve |
| 42 | ``` | 42 | ``` | ||
| 43 | 43 | ||||
| 44 | ### 3. Build and Deploy | 44 | ### 3. Build and Deploy | ||
M wiki/guides/podman-rootless.md +2 -2
| @@ -109,7 +109,7 @@ sudo mv gordon /usr/local/bin/ | |||
| 109 | 109 | Generate initial config: | |
| 110 | 110 | ||
| 111 | 111 | ```bash | |
| 112 | - | gordon start | |
| 112 | + | gordon serve | |
| 113 | 113 | # Press Ctrl+C after config is created | |
| 114 | 114 | ``` | |
| 115 | 115 | ||
| @@ -138,7 +138,7 @@ After=podman.socket | |||
| 138 | 138 | Type=simple | |
| 139 | 139 | Restart=always | |
| 140 | 140 | RestartSec=5 | |
| 141 | - | ExecStart=/usr/local/bin/gordon start | |
| 141 | + | ExecStart=/usr/local/bin/gordon serve | |
| 142 | 142 | ||
| 143 | 143 | [Install] | |
| 144 | 144 | WantedBy=default.target | |
| @@ -109,7 +109,7 @@ sudo mv gordon /usr/local/bin/ | |||||
| 109 | Generate initial config: | 109 | Generate initial config: | ||
| 110 | 110 | ||||
| 111 | ```bash | 111 | ```bash | ||
| 112 | - | gordon start | 112 | + | gordon serve |
| 113 | # Press Ctrl+C after config is created | 113 | # Press Ctrl+C after config is created | ||
| 114 | ``` | 114 | ``` | ||
| 115 | 115 | ||||
| @@ -138,7 +138,7 @@ After=podman.socket | |||||
| 138 | Type=simple | 138 | Type=simple | ||
| 139 | Restart=always | 139 | Restart=always | ||
| 140 | RestartSec=5 | 140 | RestartSec=5 | ||
| 141 | - | ExecStart=/usr/local/bin/gordon start | 141 | + | ExecStart=/usr/local/bin/gordon serve |
| 142 | 142 | ||||
| 143 | [Install] | 143 | [Install] | ||
| 144 | WantedBy=default.target | 144 | WantedBy=default.target | ||