Skip to content

Packages

Docker

Docker images are created with the following tags:

  • latest: latest stable version
  • major, major.minor and major.minor.rev tags
  • edge: unstable development version

It is recommaded to use docker compose:

Example docker compose fil with two databases and a backup runner container
services:
  db-backup:
    image: ghcr.io/burgdev/db-backup-runner:next-alpine
    restart: unless-stopped
    container_name: docker-db-auto-backup
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro" # required
      - ./backups:/tmp/db_backup_runner # required, backup directory
Run a custom command:

$ docker compose up # start services
$ docker compose run db-backup [OPTIONS] COMMAND [ARGS]... # (1)!
  1. Run db-backup-runner subcommands.

It is also possible to run it with docker directly:

Pull latest docker image
$ docker pull ghcr.io/burgdev/db-backup-runner:latest
$ docker run --rm -it \
    -v /var/run/docker.sock:/var/run/docker.sock:ro \
    -v ./backups:/tmp/db_backup_runner ghcr.io/burgdev/db-backup-runner:latest \
    backup --project my-project

Tip

A --project name is needed or the --global flag in order to find the backup containers.

PyPi

The script is also published as PyPi package.

Run it as uv tool:

$ uvx db-backup-runner [OPTIONS] COMMAND [ARGS]...

Install it in isolated environment with pipx:

$ pipx install db-backup-runner
$ db-backup-runner [OPTIONS] COMMAND [ARGS]...

Install it with pip:

$ pip install db-backup-runner
$ db-backup-runner [OPTIONS] COMMAND [ARGS]...