Backup Command

Manage database backups and volume backups.

gordon backups databases

Database backups are logical PostgreSQL backups made with pg_dump.

gordon backups databases <subcommand>

Subcommands:

list [domain] - List database backups
run <domain> [--db <name>] - Trigger an immediate database backup
detect <domain> - Detect supported databases for a domain
status - Show database backup status

Compatibility aliases remain available: gordon backups list, run, detect, and status map to database backups.

gordon backups volumes

Volume backups are best-effort filesystem archives of Gordon-managed named volumes, uploaded to S3.

gordon backups volumes <subcommand>

Subcommands:

list [domain] - List completed volume backup archives
run [domain] [--volume <name>] - Trigger volume backups now
status - Show completed archives plus current/recent in-memory job state

Volume backups exclude bind mounts, tmpfs mounts, anonymous volumes, and non-Gordon volumes. Live archives are not application-consistent unless the application is quiesced or stopped.

Examples

# Database backups
gordon backups databases list
gordon backups databases run app.example.com --db postgres
gordon backups databases detect app.example.com
gordon backups databases status

# Volume backups
gordon backups volumes list
gordon backups volumes list app.example.com
gordon backups volumes run
gordon backups volumes run app.example.com --volume gordon-app-example-com-data
gordon backups volumes status

JSON Output

Database and volume list commands support --json.

gordon backups volumes list --json

Required Permissions

Read operations (list, status, detect) require admin:status:read.
run requires admin:config:write.

source

1# Backup Command
2
3Manage database backups and volume backups.
4
5## gordon backups databases
6
7Database backups are logical PostgreSQL backups made with `pg_dump`.
8
9```bash
10gordon backups databases <subcommand>
11```
12
13Subcommands:
14
15- `list [domain]` - List database backups
16- `run <domain> [--db <name>]` - Trigger an immediate database backup
17- `detect <domain>` - Detect supported databases for a domain
18- `status` - Show database backup status
19
20Compatibility aliases remain available: `gordon backups list`, `run`, `detect`, and `status` map to database backups.
21
22## gordon backups volumes
23
24Volume backups are best-effort filesystem archives of Gordon-managed named volumes, uploaded to S3.
25
26```bash
27gordon backups volumes <subcommand>
28```
29
30Subcommands:
31
32- `list [domain]` - List completed volume backup archives
33- `run [domain] [--volume <name>]` - Trigger volume backups now
34- `status` - Show completed archives plus current/recent in-memory job state
35
36Volume backups exclude bind mounts, tmpfs mounts, anonymous volumes, and non-Gordon volumes. Live archives are not application-consistent unless the application is quiesced or stopped.
37
38## Examples
39
40```bash
41# Database backups
42gordon backups databases list
43gordon backups databases run app.example.com --db postgres
44gordon backups databases detect app.example.com
45gordon backups databases status
46
47# Volume backups
48gordon backups volumes list
49gordon backups volumes list app.example.com
50gordon backups volumes run
51gordon backups volumes run app.example.com --volume gordon-app-example-com-data
52gordon backups volumes status
53```
54
55## JSON Output
56
57Database and volume list commands support `--json`.
58
59```bash
60gordon backups volumes list --json
61```
62
63## Required Permissions
64
65- Read operations (`list`, `status`, `detect`) require `admin:status:read`.
66- `run` requires `admin:config:write`.
67
68## Related
69
70- [CLI Commands](./index.md)
71- [Backups Configuration](../config/backups.md)

backup.md RawHistoryFolder