Go to file
Einar Forselv ef4ce2ecb4 utils.strip_root 2019-11-25 22:28:04 +01:00
restic_volume_backup utils.strip_root 2019-11-25 22:28:04 +01:00
tests pep8 and spelling errors 2019-11-12 12:39:49 +01:00
.dockerignore Cleanup 2019-11-15 14:23:56 +01:00
.gitignore Cleanup 2019-11-15 14:23:56 +01:00
Dockerfile dockerfile: develop install for now 2019-11-25 21:19:31 +01:00
README.md Spelling error 2019-04-17 20:13:23 +02:00
crontab Cleanup 2019-11-15 14:23:56 +01:00
docker-compose.yaml Fix broken compose file 2019-11-12 12:10:19 +01:00
entrypoint.sh Cleanup 2019-11-15 14:23:56 +01:00
pytest.ini Basic testcase setup 2019-04-15 19:07:14 +02:00
restic_volume_backup.env Basic env file 2019-04-15 17:03:47 +02:00
setup.py Add rvb command shortcut 2019-11-12 12:09:59 +01:00

README.md

restic-volume-backup

WORK IN PROGRESS

Backup using https://restic.net/ for a docker-compose setup.

Automatically detects and backs up volumes in a docker-compose setup. This includes both host mapped volumes and actual docker volumes.

  • Cron triggers backup
  • Volumes for all running containers are backed up

Configuration

Required env variables for restic:

RESTIC_REPOSITORY
RESTIC_PASSWORD

Backend specific env vars : https://restic.readthedocs.io/en/stable/040_backup.html#environment-variables

Example compose setup:

version: '3'
services:
  backup:
    build: restic-volume-backup
    environment:
      - RESTIC_REPOSITORY=<whatever restic supports>
      - RESTIC_PASSWORD=hopefullyasecturepw
    env_file:
      - some_other_vars.env
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro
  example:
    image: some_image
    # Enable volume backup with label
    labels:
      restic-volume-backup.enabled: true
    # These volumes will be backed up
    volumes:
      # Docker volume
      - media:/srv/media
      # Host map
      - /srv/files:/srv/files

volumes:
  media:

Include

  example:
    image: some_image
    labels:
      restic-volume-backup.enabled: true
      restic-volume-backup.include: "files,data"
    volumes:
      # Source don't match include filter. No backup.
      - media:/srv/media
      # Matches include filter
      - files:/srv/files
      - /srv/data:/srv/data

volumes:
  media:
  files:

Exclude:

  example:
    image: some_image
    labels:
      restic-volume-backup.enabled: true
      restic-volume-backup.exclude: "media"
    volumes:
      # Excluded by filter
      - media:/srv/media
      # Backed up
      - files:/srv/files
      - /srv/data:/srv/data

volumes:
  media:
  files:

Running Tests

python setup.py develop
pip install -r tests/requirements.txt
pytest tests

TEMP

mysql://user:pw@host:port/dbname
postgresql://user:pw@host:port/dbname