|
| 1 | +# ----------------------------------------------------------------------------- |
| 2 | +## |
| 3 | +# Default configuration for backup & restore related commands |
| 4 | +# |
| 5 | +# This file should contain useful defaults to reduce amount of configuration |
| 6 | +# work needed in derived profiles. It should NOT contain a full backup config |
| 7 | +# having "source" definitions, since these whould be inherited by all backup |
| 8 | +# profiles that derive from "base" (or "default") settings. |
| 9 | +# |
| 10 | +# To define backup sources, create a profile config in "profiles.d" like: |
| 11 | +# |
| 12 | +# >>> "profiles.d/example.conf" |
| 13 | +# |
| 14 | +# [profiles.example] |
| 15 | +# description = "Backup example" |
| 16 | +# inherit = "base" |
| 17 | +# |
| 18 | +# [profiles.example.backup] |
| 19 | +# schedule = "daily" |
| 20 | +# source = [ |
| 21 | +# "/path/to/backup", |
| 22 | +# "/other/path/to/backup", |
| 23 | +# ] |
| 24 | +# |
| 25 | +# <<< |
| 26 | +# |
| 27 | + |
| 28 | + |
| 29 | +## |
| 30 | +# Backup defaults |
| 31 | +[profiles.default.backup] |
| 32 | + |
| 33 | +# Hostname to identify backup snapshots in the repository from this host |
| 34 | +{{ template "conf:default-host" . }} |
| 35 | + |
| 36 | +# |
| 37 | +# Tags (besides host & path) are used to identify snapshots belonging to |
| 38 | +# a certain backup. |
| 39 | +# |
| 40 | +# Multiple tags can be defined, but profile name should always be included, |
| 41 | +# the expression "{{ .Profile.Name }}" resolves to the currently active |
| 42 | +# profile name. |
| 43 | +# |
| 44 | +# Notes: |
| 45 | +# |
| 46 | +# - Set the same tags for "backup" and "retention" unless you know what you |
| 47 | +# are doing. Retention uses the tags defined in the backup section when |
| 48 | +# "tag = true" is set in the retention configuration and this default |
| 49 | +# setup should not be changed. |
| 50 | +# |
| 51 | +# - Most of the command sections should use "tag = true" to copy tags from |
| 52 | +# backup so that restore, mount, etc. relate to the selected profile. |
| 53 | +# |
| 54 | +tag = [ "{{ .Profile.Name }}" ] |
| 55 | + |
| 56 | +# Exclude known cache files & folders from backups |
| 57 | +exclude-caches = true |
| 58 | + |
| 59 | +# Exclude nested filesystems |
| 60 | +# Prefer overriding this option in dedicated backup profiles instead of |
| 61 | +# globally as it can greatly increase the volume if nested FS mounts are |
| 62 | +# contained in backup source paths. |
| 63 | +one-file-system = true |
| 64 | + |
| 65 | +# Toggle whether a failure in reading a backup source is considered an error |
| 66 | +no-error-on-warning = false |
| 67 | + |
| 68 | +# Wait on acquiring locks when running the profile on a schedule |
| 69 | +schedule-lock-wait = "45m" |
| 70 | + |
| 71 | +# Specify the user that runs profile tasks on a schedule |
| 72 | +# "system" - root runs the profile tasks |
| 73 | +# "user" - user that created the schedule runs the profile tasks |
| 74 | +schedule-permission = "system" |
| 75 | + |
| 76 | +# Toggle verbose output for troubleshooting |
| 77 | +#verbose = false |
| 78 | + |
| 79 | +# Toggles immediate repository check before and after backup. |
| 80 | +# Checks can be heavy on resources. Consider scheduling "maintenance" |
| 81 | +# (see "conf.d/check.conf") instead of enabling checks here. |
| 82 | +check-before = false |
| 83 | +check-after = false |
| 84 | + |
| 85 | + |
| 86 | +## |
| 87 | +# Snapshot retention defaults |
| 88 | +[profiles.default.retention] |
| 89 | +# Remove obsolete snapshots prior to starting a backup |
| 90 | +before-backup = false |
| 91 | +# Remove obsolete snapshots after a successful backup |
| 92 | +after-backup = true |
| 93 | + |
| 94 | +# |
| 95 | +# Note: Retention operates on host, path and tag filters to identify snapshots |
| 96 | +# to retain or remove. In most cases these filters should be in sync with |
| 97 | +# the backup configuration of a profile so that snapshots will be removed |
| 98 | +# that truely belong to a profile's backup. |
| 99 | +# |
| 100 | + |
| 101 | +# Copying "host" block to identify snapshots by hostname |
| 102 | +{{ template "conf:default-host" . }} |
| 103 | + |
| 104 | +# Retention allows to build tag filter from backup with 'true'. It is strongly |
| 105 | +# advised not to change this as tags are the primary filter besides hostname. |
| 106 | +tag = true |
| 107 | + |
| 108 | +# Copying backup source paths to identify snapshots to retain or remove. |
| 109 | +# Set to "true" to copy source paths from backup, "false" or a list of paths |
| 110 | +# to disable or customize the path filter. |
| 111 | +# |
| 112 | +# Note: Path filter matches literally on absolute paths recorded as sources |
| 113 | +# when a snapshot was created. Tag and host filters are better suited to |
| 114 | +# identify snapshots of certain profile. Default is not to use path. |
| 115 | +path = false |
| 116 | + |
| 117 | +# Specify the snapshots to keep when checking for obsolete snapshots |
| 118 | +# Snapshots that do not match any condition are removed |
| 119 | +keep-tag = [ "forever" ] |
| 120 | +keep-last = 3 |
| 121 | +#keep-hourly = 1 |
| 122 | +#keep-daily = 1 |
| 123 | +#keep-weekly = 1 |
| 124 | +#keep-monthly = 1 |
| 125 | +#keep-yearly = 1 |
| 126 | +#keep-within = "30d" |
| 127 | + |
| 128 | +# Use compact format for listing snapshots |
| 129 | +#compact = false |
| 130 | + |
| 131 | +# Toggles immediate prune of the repository as snapshots are removed. |
| 132 | +# |
| 133 | +# While removing snapshots is a light operation, prune (reclaim space) can |
| 134 | +# be heavy on resources as it rewrites parts of the repository. |
| 135 | +# Consider scheduling "maintenance" (see "conf.d/prune.conf") instead of |
| 136 | +# enabling prune here. |
| 137 | +# |
| 138 | +# Also an attempt to recover a removed snapshot with "resticprofile recover" |
| 139 | +# only works as long as the repository was not yet pruned. |
| 140 | +prune = false |
| 141 | + |
| 142 | + |
| 143 | +## |
| 144 | +# Defaults for operations on repository snapshots of this host |
| 145 | +# Usage: |
| 146 | +# - "resticprofile snapshots" - view snapshots |
| 147 | +# - "resticprofile mount /mnt/restore" - mount snapshots |
| 148 | +# - "resticprofile ls latest /" - list files in a snapshot |
| 149 | +# - "resticprofile dump latest /file" - dump a file to stdout |
| 150 | +# - "resticprofile find PATTERN..." - find files in snapshots |
| 151 | +# - "resticprofile copy --repo2=..." - copy snapshots to repo2 |
| 152 | +# - "resticprofile restore --target=/to/dir --include=PATTERN... latest" |
| 153 | +[profiles.default.copy] |
| 154 | +{{ template "conf:default-host" . }} |
| 155 | +schedule-lock-wait = "1h30m" |
| 156 | +[profiles.default.dump] |
| 157 | +{{ template "conf:default-host" . }} |
| 158 | +[profiles.default.find] |
| 159 | +{{ template "conf:default-host" . }} |
| 160 | +[profiles.default.forget] |
| 161 | +{{ template "conf:default-host" . }} |
| 162 | +[profiles.default.ls] |
| 163 | +{{ template "conf:default-host" . }} |
| 164 | +[profiles.default.mount] |
| 165 | +{{ template "conf:default-host" . }} |
| 166 | +[profiles.default.restore] |
| 167 | +{{ template "conf:default-host" . }} |
| 168 | +[profiles.default.snapshots] |
| 169 | +{{ template "conf:default-host" . }} |
| 170 | +[profiles.default.stats] |
| 171 | +{{ template "conf:default-host" . }} |
| 172 | +[profiles.default.tag] |
| 173 | +{{ template "conf:default-host" . }} |
| 174 | + |
| 175 | + |
| 176 | +## |
| 177 | +# Setup operations on repository snapshots for profiles deriving from "base" |
| 178 | +# Usage: |
| 179 | +# - "resticprofile profileName.snapshots" - view snapshots |
| 180 | +# - "resticprofile profileName.mount /mnt/restore" - mount snapshots |
| 181 | +# - "resticprofile profileName.ls latest /" - list files in a snapshot |
| 182 | +# - "resticprofile profileName.dump latest /file" - dump a file to stdout |
| 183 | +# - "resticprofile profileName.find PATTERN..." - find files in snapshots |
| 184 | +# - "resticprofile profileName.copy --repo2=..." - copy snapshots to repo2 |
| 185 | +# - "resticprofile profileName.restore --target=/to/dir latest" |
| 186 | +[profiles.base.copy] |
| 187 | +tag = true |
| 188 | +[profiles.base.dump] |
| 189 | +tag = true |
| 190 | +[profiles.base.find] |
| 191 | +tag = true |
| 192 | +[profiles.base.forget] |
| 193 | +tag = true |
| 194 | +[profiles.base.ls] |
| 195 | +tag = true |
| 196 | +[profiles.base.mount] |
| 197 | +tag = true |
| 198 | +[profiles.base.restore] |
| 199 | +tag = true |
| 200 | +[profiles.base.snapshots] |
| 201 | +tag = true |
| 202 | +[profiles.base.stats] |
| 203 | +tag = true |
| 204 | +[profiles.base.tag] |
| 205 | +tag = true |
| 206 | + |
| 207 | + |
| 208 | +# ----------------------------------------------------------------------------- |
0 commit comments