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
| Option | Type | Default | Description |
|---|---|---|---|
repository | string | – | Where snapshots are stored: a local path, sftp://user@host/path or s3://bucket/prefix. |
password_file | string | – | File holding the repository password. Takes precedence over the ROWANKEEP_PASSWORD variable. |
compression | string | auto | off, auto or max. With auto, data that does not compress is stored as it is. |
exclude | list | [] | Patterns of paths to leave out, in gitignore syntax. |
one_file_system | bool | false | Do not cross into other mounted filesystems. |
retention.keep_hourly | int | 24 | Hourly snapshots to keep. |
retention.keep_daily | int | 7 | Daily snapshots to keep. |
retention.keep_weekly | int | 4 | Weekly snapshots to keep. |
retention.keep_monthly | int | 12 | Monthly snapshots to keep. |
upload.connections | int | 5 | Parallel connections to the backend. |
upload.limit | string | – | Bandwidth limit, such as 20MiB/s. Empty means no limit. |
cache_dir | string | ~/.cache/rowankeep | Local cache of repository metadata. |
log.level | string | info | debug, info, warn or error. |