Rowankeep
Docs / Reference

Configuration

Rowankeep reads its configuration from /etc/rowankeep/rowankeep.toml. Pass --config to point it elsewhere. The file is TOML, and every option in it is optional.

Example

# /etc/rowankeep/rowankeep.toml
repository = "s3://backups/web-01"
password_file = "/etc/rowankeep/password"
exclude = ["*.tmp", "/home/*/.cache"]

[retention]
keep_daily = 14
keep_weekly = 8

[upload]
limit = "20MiB/s"

Environment variables

Every option can also be set in the environment: write the key in upper case, replace dots with underscores and put ROWANKEEP_ in front, so retention.keep_hourly becomes ROWANKEEP_RETENTION_KEEP_HOURLY. The environment takes precedence over the file.

All options

OptionTypeDefaultDescription
repositorystring–Where snapshots are stored: a local path, sftp://user@host/path or s3://bucket/prefix.
password_filestring–File holding the repository password. Takes precedence over the ROWANKEEP_PASSWORD variable.
compressionstringautooff, auto or max. With auto, data that does not compress is stored as it is.
excludelist[]Patterns of paths to leave out, in gitignore syntax.
one_file_systemboolfalseDo not cross into other mounted filesystems.
retention.keep_hourlyint24Hourly snapshots to keep.
retention.keep_dailyint7Daily snapshots to keep.
retention.keep_weeklyint4Weekly snapshots to keep.
retention.keep_monthlyint12Monthly snapshots to keep.
upload.connectionsint5Parallel connections to the backend.
upload.limitstring–Bandwidth limit, such as 20MiB/s. Empty means no limit.
cache_dirstring~/.cache/rowankeepLocal cache of repository metadata.
log.levelstringinfodebug, info, warn or error.