1# Config Commands
2
3Inspect Gordon server configuration.
4
5Remote targeting uses client config or an active remote by default.
6Use `--remote` and `--token` to override. See [CLI Overview](./index.md).
7
8## gordon config
9
10### Subcommands
11
12| Subcommand | Description |
13|------------|-------------|
14| `show` | Show server configuration |
15| `validate` | Statically validate a local configuration file |
16
17---
18
19## gordon config show
20
21Display the Gordon installation configuration including server settings,
22network isolation, volumes, and external route domains. App routes live
23under `gordon apps show`, never here. Sensitive filesystem paths and upstream external route targets are redacted by default.
24
25```bash
26gordon config show
27gordon config show --json
28gordon config show --remote https://gordon.mydomain.com --token $TOKEN
29```
30
31### Flags
32
33| Flag | Description |
34|------|-------------|
35| `--json` | Output as JSON |
36
37### JSON Output
38
39```json
40{
41  "server": {
42    "port": 1111,
43    "registry_port": 5000,
44    "registry_domain": "reg.example.com"
45  },
46  "network_isolation": {
47    "enabled": true,
48    "prefix": "gordon"
49  },
50  "volumes": {
51    "auto_create": true,
52    "prefix": "gordon",
53    "preserve": true
54  },
55  "external_routes": [
56    {"domain": "reg.example.com"}
57  ]
58}
59```
60
61External route targets and `server.data_dir` are intentionally omitted from the default admin config response because they reveal internal network and filesystem layout.
62
63---
64
65## gordon config validate
66
67Statically validates a candidate configuration file before it is installed.
68This command is local-only: `--remote` is rejected. Validation is static —
69runtime, ACTIVE-state, secret, pull, and listener checks are not performed.
70A file that fails validation exits non-zero; `--json` is still written first.
71
72```bash
73gordon config validate --file ./gordon.toml
74gordon config validate --file ./gordon.toml --json
75```
76
77### Flags
78
79| Flag | Description |
80|------|-------------|
81| `--file` | Local candidate configuration file (required) |
82| `--json` | Output as JSON |
83
84### JSON Output
85
86On success:
87
88```json
89{
90  "valid": true,
91  "diagnostics": [],
92  "scope": "static"
93}
94```
95
96On failure, `valid` is `false` and `diagnostics` carries the failure:
97
98```json
99{
100  "valid": false,
101  "diagnostics": [
102    {"code": "config-invalid", "key": "", "message": "configuration failed static validation"}
103  ],
104  "scope": "static"
105}
106```
107
108## Related
109
110- [CLI Overview](./index.md)
111- [Status Command](./status.md)
112- [Apps Commands](./apps.md)