borg¶

This plugin will perform a borg backup in a specific repo. It will also run a borg prune-command to clean up old backups.

Dependencies¶

borg

Preparation¶

Create a borg repository local or on a remote machine:

borg init -e none /media/backup/my_borg_backup_repo

Configuration¶

A list of required configuration keys:

source: A list of sources to backup
destination A borg-repository to backup to

Here’s an example:

logs:
  dir: /var/log/dothebackup
  keep: 10
backup:
  my_borg_backup:
    type: borg
    enabled: yes
    source:
        - /etc
        - /home
        - /srv
    destination: /media/backup/my_borg_backup_repo
    exclude:
        - /home/user/Downloads
    keep:  # Backups to keep
        daily: 7  # last 7 days
        weekly: 4  # last 4 weeks
        monthly: 6  # last 6 months
    check: yes  # runs check command after each run on the repo

It’s also possible to use a remote destination:

destination: ssh://user@remotebox:/media/backup/my_borg_backup_repo

API¶

Borg.

dothebackup.plugs.borg.main(config)[source]¶

Command builder.

Parameters:	config (`Dict`[`str`, `Union`[`str`, `List`[`str`], `bool`]]) – config snippt for this plugin
Return type:	`List`[`List`[`str`]]
Returns:	Commands to create the backup