Skip to content

Ansible

We provide a ready-to-use Ansible role to install Borg, Borgmatic and a cron job on a Linux client (tested on Ubuntu/Debian/CentOS/Fedora). Example usage in a playbook:

- hosts: webservers
roles:
- role: borgbase.ansible_role_borgbackup
borgbackup_config:
encryption_passphrase: CHANGEME
repositories:
- ssh://m5vz9gp4@m5vz9gp4.repo.borgbase.com/./repo
source_directories:
- /srv/www
- /var/lib/automysqlbackup
  1. Install via Ansible Galaxy or clone Github repository into your roles folder.
  2. Add a new repository without SSH key in BorgBase
  3. Replace Borg passphrase, repository URL and source directories in your playbook
  4. Run playbook against client host. A new SSH key will be created and displayed.
  5. Add new SSH key in BorgBase.
  6. Run borgmatic repo-create --encryption repokey-blake2 to validate the connection and initialize the new repository.

Learn more on the Github page of the project.

Interacting with the BorgBase API via Ansible

Section titled “Interacting with the BorgBase API via Ansible”

Andy Hawkins has created a range of Ansible modules that interact with the BorgBase API for a fully automated setup. They allow adding a repository or SSH key to BorgBase. Install it from Ansible Galaxy:

$ ansible-galaxy collection install adhawkins.borgbase

For more details see the Github repo or the module documentation.