Reference
CLI
The postkeep binary has four subcommands (crates/server/src/cli.rs).
postkeep serve
Run the server.
Every option can be set with a POSTKEEP_* environment variable. A
command-line flag still wins over the variable.
postkeep serve --help lists every flag. The essentials are also in the
configuration reference.
postkeep generate-key
Print a new random master key (32 random bytes, base64).
postkeep healthcheck
Check that a local server answers /healthz (for container health checks).
| Flag | Environment | Default |
|---|---|---|
--bind |
POSTKEEP_BIND |
0.0.0.0:8080 |
0.0.0.0 is checked via 127.0.0.1.
postkeep migrate
Apply pending database migrations and exit (for release commands). It prints the migrations it applied, or that the database is up to date, and exits 0 in both cases.
| Flag | Environment | Default |
|---|---|---|
--migrate-url |
POSTKEEP_DATABASE_MIGRATE_URL |
(the database URL) |
--database-url |
POSTKEEP_DATABASE_URL |
sqlite://postkeep.db |