Skip to content

CLI Reference

docker-backup provides a command-line interface for managing backups and running the daemon.

Global Flags

These flags apply to all commands:

Flag Default Description
--docker-host unix:///var/run/docker.sock Docker daemon socket
--socket /var/run/docker-backup.sock Unix socket for daemon communication
--log-level info Log level: debug, info, warn, error
--log-format text Log format: text, json

Commands

daemon

Start the backup daemon. See daemon for full documentation.

docker-backup daemon [flags]

backup

Backup management commands. See backup for full documentation.

docker-backup backup <subcommand> [flags]

Subcommands:

  • run <container> - Trigger immediate backup
  • list <container> - List backups for a container
  • delete <container> <key> - Delete a backup
  • restore <container> <key> - Restore a backup

htpasswd

Generate htpasswd-style password hashes. See htpasswd for full documentation.

docker-backup htpasswd <username> [flags]

Exit Codes

Code Description
0 Success
1 General error

Command Reference

  • daemon


    Start the backup daemon

    daemon

  • backup


    Manage backups (run, list, delete, restore)

    backup

  • htpasswd


    Generate password hashes

    htpasswd