ryba 0.1.1

Local targets

Backs up one directory on your local machine to another. Useful for backing up to a mounted external hard drive, for example.

[target.tardis]
type = "local"
path = "/mount/tardis"

SSH targets

Backs up to a remote server using SSH. Defaults for some SSH options are pulled from ~/.ssh/config if possible.

[target.briefcase]
type = "ssh"

Available options:

hostname

The hostname of the server. Defaults to the target name if not set.

username

The username to authenticate to the remote server with. Defaults to your username if not set.

port

The SSH port to use.

path

A base path to use for all backups. Optional, defaults to /. This is useful if the server has an external drive mounted that you would like to place all backups on, for example. All target directories from the backup definition are taken as relative to this path.

Keep all

The most basic strategy simply keeps all backups.

[rotate.keep-all]
strategy = "all"

Keep n most recent

This will keep a fixed number of the most recent backups.

[rotate.keep-7]
strategy = "latest"
count = 7

Date buckets

This will keep some configurable number of backups per time period.

[rotate.6-months]
strategy = "date-bucket"
# Keep one backup per day for seven days
day = 7
# Keep one backup per week for four weeks
week = 4
# Keep one backup per month for six months
month = 6

Available buckets are hour, day, week, month, year. Backups are sorted in to buckets based on their timestamp. A setting of day = 7 will keep one backup from the seven most recent distinct days. A setting of week = 4 will keep one backup from the four most recent distinct weeks. The value "all" for a bucket can be used to keep one backup per bucket with no limit. A setting of year = "all" will keep one backup per year with no limit. A backup can be kept by multiple buckets.

One backup is kept per bucket, but the buckets do not have to be contiguous in time. If you only make one backup per week, and have days = 7, this will still keep one backup per distinct days, but the days will be spread over seven weeks.

By default, the oldest backup in a bucket will be kept. If you took a backup every day, and had month = 6, one backup from the first day of the last six months would be kept. This would result in keeping backups from 2021-01-01, 2021-02-01, 2021-03-01, and so forth. If you would prefer to keep the newest backup in a bucket instead, set prefer_newest = true. This would result in keeping a backup from 2021-01-31, 2021-02-28, 2021-03-31, and so forth.