servercontainers/dirvish repository overview

⁠Docker Dirvish Backup System (servercontainers/dirvish) [x86 + arm]

dirvish on debian

⁠Changelogs

• 2021-07-27
  • fix how report fetches latest backup of the day
  • fix \r windows linebreaks in master.conf
• 2021-03-19
  • configure return-address for status mail
• 2021-03-17
  • multiarch build
  • rewrite to debian:buster

⁠What is it

This Dockerfile (available as servercontainers/dirvish) gives you a Dirvish Backup System in a container.

• Backup System in Container
  • runs at a specific time in infinite loop
• Standalone Backup
  • container exits after backup is done
  • good if triggered from external cronjob etc.

For Configuration of the Server you use environment Variables and volume files.

It's based on the debian⁠ Image

View in Docker Registry servercontainers/dirvish⁠

View in GitHub ServerContainers/dirvish⁠

⁠Environment variables

• STANDALONE

  • if this variable is set to any value the container stops after the backup is done
  • default not set

• TZ

  • specify the timezone inside the container
  • default Europe/Berlin

• CRONTIME

  • overwrite default crontime with your one
  • default 30 4 * * *

• MAIL_RECIPIENTS

  • list of mail addresses to recieve status mail after backup
  • e.g.: [email protected] [email protected] [email protected]

• RETURN_ADDRESS

  • sender of status email
  • default: [email protected]
  • e.g.: [email protected]

⁠Volumes

• /config
  • this is where the container looks for:
    • master.conf (dirvish main configuration file - see example or official manual)
    • id_rsa (ssh private key to connect to backup-clients/servers)
      • don't forget to specify it inside master.conf
    • ida_rsa.pub (ssh public key - not needed - only on clients)
• /backups
  • this is where the container stores backups and looks for backup-client configurations
  • default layout beneath this folder: bank/backup/dirvish/default.conf

Take a look at the GitHub Repo, you'll find a example there.

⁠Cheat Sheet

⁠SSH Key generation

To connect to your hosts, you need to install a ssh keypair on them. This keypair should be moved to the config folder of the container. Don't forget to specify it in the master.conf as well!

To generate a keypair just execute ssh-keygen -t rsa and follow the instructions. You'll find your keypair beneath ~/.ssh.

Now install the public keys on the servers you want to backup, and the private key on this container.

⁠Dirvish

• Initialize new vault
  • time dirvish --init --vault name_of_vault