1# Status Command
2
3Show Gordon server status and container health.
4
5## gordon status
6
7Display server configuration and container status for all routes.
8
9```bash
10gordon status --remote https://gordon.mydomain.com --token $TOKEN
11```
12
13> **Note:** The status command requires remote mode. See [CLI Overview](./index.md) for targeting options.
14
15### Output
16
17```
18Gordon Status
19
20Domain: registry.example.com
21Registry Port: 5000
22Server Port: 8080
23Routes: 3
24Auto-Route: true
25Network Isolation: false
26
27Container Status:
28  app.example.com: running
29  api.example.com: running
30  worker.example.com: stopped
31```
32
33### Information Displayed
34
35| Field | Description |
36|-------|-------------|
37| Domain | Registry domain from configuration |
38| Registry Port | Docker registry port |
39| Server Port | Gordon admin API port |
40| Routes | Total configured routes |
41| Auto-Route | Whether auto-routing is enabled |
42| Network Isolation | Whether network isolation is enabled |
43| Container Status | Status of each route's container |
44
45### Container States
46
47| State | Description |
48|-------|-------------|
49| running | Container is running and healthy |
50| stopped | Container was stopped |
51| exited | Container exited (check logs for errors) |
52| paused | Container is paused |
53| unknown | Unable to determine container state |
54
55## Flags
56
57The status command uses global flags for remote access:
58
59| Flag | Description |
60|------|-------------|
61| `--remote` | Remote Gordon URL |
62| `--token` | Authentication token |
63
64## Environment Variables
65
66| Variable | Description |
67|----------|-------------|
68| `GORDON_REMOTE` | Remote Gordon URL |
69| `GORDON_TOKEN` | Authentication token |
70
71## Examples
72
73### Check Remote Server Status
74
75```bash
76# Using flags
77gordon status --remote https://gordon.mydomain.com --token $TOKEN
78
79# Using environment variables
80export GORDON_REMOTE=https://gordon.mydomain.com
81export GORDON_TOKEN=your-token
82gordon status
83```
84
85### Quick Health Check
86
87```bash
88# Check if all containers are running
89gordon status --remote https://gordon.mydomain.com --token $TOKEN | grep -E "(running|stopped|exited)"
90```
91
92## Required Permissions
93
94The status endpoint requires `admin:status:read` scope in the authentication token.
95
96```bash
97# Generate token with required scope
98gordon auth token generate --subject admin --scopes admin:status:read
99```
100
101## Related
102
103- [Serve Command](./serve.md)
104- [Routes Command](./routes.md)
105- [Remote CLI Management](/wiki/guides/remote-cli.md)