Ansible Tarsnap

ansible role for operating tarsnap backups
Alternatives To Ansible Tarsnap
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Ansible Role Gitlab653
18 days ago8mitJinja
Ansible Role - GitLab
2 days agogpl-3.0Jinja
[mirror] Install and manage self-hosted services/applications, on your own server(s) - ansible collection and utilities
Ansible Role Borgbackup172
3 months ago35mitJinja
Ansible role to set up Borg and Borgmatic
17 days ago3April 24, 202126mitGo
シンプル - Discord Bot with role selection, moderation, karma ranking, a starboard, code execution, raid alerting, backups, a web interface, twitch notifications and more!
4 years ago13mitShell
Ansible role to backup files, databases
2 years ago3Python
PG Extractor - Advanced PostgreSQL Dump Filter
Ansible Role Backup134
2 months agomitShell
Ansible Role - Backup for simple servers
Ansible Postgresql99
7 months ago16Python
An Ansible role for managing a PostgreSQL server
Trellis Backup Role60
a year ago
Ansible backup role to use with trellis. Works with s3, FTP, local disk...
27 years ago3August 04, 20152mitPython
A command line tool to orchestrate MongoDB backups
Alternatives To Ansible Tarsnap
Select To Compare

Alternative Project Comparisons

Build Status


Is ...

  • An ansible role for operating tarsnap backups
  • An ansible-pull compatible playbook for standalone installations.

The role downloads sources for, verifies the gpg-encrypted sha signature, compiles, and installs Tarsnap.
Batteries included: tarsnapper, cron job, shell wrapper, and logrotate policy.




  • Tarsnap account
  • Tarsnap machine key file
    • instructions to generate one are in the standalone section
    • important this role assumes you are responsible for copying this key to tarsnap_keyfile. See [role variables](#role variables)

role variables

Available variables are listed below, along with default values (see defaults/main.yml):

tarsnap_version: 1.0.35
tarsnap_keyfile: "/root/tarsnap.key"
tarsnap_cache: "/usr/local/tarsnap-cache"

The role-installed .tarsnaprc file will automatically exclude the tarsnap_cache folder and reference the tarsnap_keyfile for backups. Your play or an out-of-band process is responsible for creating the keyfile and placing it at this location. See the standalone section.

tarsnap_cron_minute: "0"
tarsnap_cron_hour: "3"
tarsnap_cron_day: "*"
tarsnap_cron_month: "*"

Controls the period at which the backup job wrapper /root/ is executed.
The period should be at least as frequent as the smallest generation defined by your tarsnapper.conf deltas (e.g. if your smallest delta is 1h, you should set all these vars to * except for tarsnap_cron_minute).
These variable map to parameters in the ansible cron module.

tarsnap_tarsnapper_conf: "tarsnapper.default.conf"

tarsnapper configuration. A default and example are provided (tarsnapper.default.conf) but you should over-ride this.

tarsnap_global_exclusions: # not defined by default

List of string glob patterns that will be added to the .tarsnaprc file. For an example list, see personal/defaults.yml


The local.yml play uses the role to install a local backup policy, either via manual execution or ansible-pull.

You should fork this repo before executing locally since the exclusion patterns and tarsnapper.conf as defined in the personal directory need to be customized.

# installs role locally, using the exclusion patterns and tarsnapper.conf
# defined in the "personal" directory
ansible-playbook -i /dev/null local.yml

# Now that tarsnap is installed, generate a tarsnap machine key.
# This will prompt for your account password
sudo tarsnap-keygen --keyfile /root/tarsnap.key --user [email protected] --machine `hostname`

# alternatively, copy your pre-registered machine key to the location defined in the tarsnap_keyfile var


Source Copyright © 2014 Paul Bauer. Distributed under the GNU General Public License v3, the same as Ansible uses. See the file COPYING.

Popular Backup Projects
Popular Role Projects
Popular Data Storage Categories

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.