CLI reference
The dockyrd binary is both the server and its admin tool. Run commands as root on the server.
Commands
| Command | What it does |
|---|---|
dockyrd serve | Starts the server. systemd runs this for you. |
dockyrd init | First-time setup: keys, database, network, proxy. Safe to rerun. |
dockyrd setup-token | Prints a new one-time setup link, as long as no owner exists. |
dockyrd admin reset-password <email> | Resets a user's password from the server. |
dockyrd admin disable-2fa <email> | Turns off two-factor for a locked-out user. |
dockyrd update [--version] | Installs the latest or a specific release. |
dockyrd doctor | Checks Docker, ports, DNS, disk, proxy config and clock, and suggests fixes. |
dockyrd proxy dump | Prints the Caddy configuration currently loaded. |
dockyrd backup | Writes a snapshot of the control-plane database. |
dockyrd version | Prints version, commit and build date. |
API client (dy)
Installed next to dockyrd for tokens and CI. Log in with an API token from Settings → Account → API tokens, then run deploy and log commands from SSH or scripts.
| Command | What it does |
|---|---|
dy login <url> <token> | Saves panel URL and API token under ~/.config/dy. |
dy whoami | Prints the authenticated user. |
dy services <project-id> | Lists services in a project. |
dy deploy <service-id> | Triggers a new deployment. |
dy logs <service-id> [runtime|access] [tail] | Fetches recent logs. |
Files and paths
| Path | Contents |
|---|---|
/usr/local/bin/dockyrd | Server binary (dockyrd serve, …) |
/usr/local/bin/dy | API client for tokens and automation |
/etc/dockyrd/ | Master key and optional dockyrd.env |
/var/lib/dockyrd/dockyrd.db | Control-plane database (SQLite) |
/var/lib/dockyrd/backups/ | Daily snapshots, seven kept |
/var/lib/dockyrd/sites/ | Static site releases |
Logs go to journald: journalctl -u dockyrd -f.