Self-hosting ยท Draft
The eddy command
Draft. This page is written from the product plan and has not been checked against a release.
The installer puts a management command at /usr/local/bin/eddy. Run it as root or with sudo.
| Command | What it does |
|---|---|
status | Shows the containers, then the version, plan and team members from inside the app container |
logs [service] | Follows the logs |
update [version] | Backs up first, pins the new version, pulls and restarts, and waits for health. On failure it puts the old version back and asks whether to restore the backup. See updates |
backup | Writes a pg_dump -Fc file into backups/, keeps the newest 14, and runs BACKUP_HOOK if set. See backups |
restore <file> | Asks for confirmation, stops the app, restores, and starts the app |
config | Opens .env in your editor, then restarts |
restart | Restarts the stack |
create-admin | Prints a one-time password-set link for a new staff account |
set-license <key> | Installs a licence key without signing in. See licence |
uninstall | Stops and removes the containers. Keeps your data and backups unless you pass --purge, which asks you to type the domain |
--purge never touches an external database.
The health endpoint at /api/health is public and returns only whether the app and database are up. It does not show a version number, so the version and plan come from eddy status.