ezbak

ezbak is a backup manager. It creates, prunes, and restores compressed archives of files and directories on the local filesystem, in AWS S3, or both, with regex file filtering, count-based and time-based retention, and point-in-time restore. It was written primarily to move shared state between jobs and hosts in an orchestrated environment like Nomad or Kubernetes. In that setting the Docker container is the main way to run it; a Python package and a command-line tool run the same backups from your own code or a shell.

ezbak is a small, focused backup manager. It does not aim to replace restic, borg, or a full backup system.

Documentation

Full documentation lives at natelandau.github.io/ezbak:

• Quickstart: a first backup in five minutes
• The orchestration pattern: backups that follow a job across hosts, with Nomad and Kubernetes examples
• Configuration reference: every option across the library, CLI, and environment

Install

uv add ezbak            # Python package
uv tool install ezbak   # command-line tool
docker pull ghcr.io/natelandau/ezbak:latest   # container

ezbak requires Python 3.11 or higher.

Quickstart

Each interface runs the same backup. Every example below writes a my-backup-<timestamp>.tgz archive to the storage location.

Python:

from ezbak import ezbak

backups = ezbak(name="my-backup", source_paths=["/data"], storage_paths=["/backups"], keep_last=7)
backups.create_backup()
backups.restore_backup(restore_path="/restore")

Command line:

ezbak --name my-backup --storage ~/Backups create --source ~/Documents

Container:

docker run -it \
    -v /path/to/source:/source:ro \
    -v /path/to/backups:/backups \
    -e EZBAK_ACTION=backup \
    -e EZBAK_NAME=my-backup \
    -e EZBAK_SOURCE_PATHS=/source \
    -e EZBAK_STORAGE_PATHS=/backups \
    -e EZBAK_KEEP_LAST=7 \
    ghcr.io/natelandau/ezbak:latest

See the quickstart for listing and restoring across all three.

Contributing

See CONTRIBUTING.md.