* refactor: Change INSTALL_PREFIX placeholder notation to templating notation
The former shell notation `$INSTALL_PREFIX` could result confusing. As
this is a placeholder that's replaced in the `make`, we switch it to a
template notation `{{ INSTALL_PREFIX }}`.
* docs: Small fix on README/manual setup
* docs(email-notif): Document the `{{ INSTALL_PREFIX }}` placeholder
co-authored-by: giuaig <13609224+giuaig@users.noreply.github.com>
* Update README.md
Co-authored-by: Gerard Bosch <30733556+gerardbosch@users.noreply.github.com>
---------
Co-authored-by: giuaig <13609224+giuaig@users.noreply.github.com>
Co-authored-by: Erik Westrup <erik.westrup@icloud.com>
46 lines
2.1 KiB
Bash
46 lines
2.1 KiB
Bash
# shellcheck shell=sh
|
|
|
|
# This is the default profile. Fill it with your desired configuration.
|
|
# Additionally, you can create and use more profiles by copying this file.
|
|
|
|
# This file (and other .env.sh files) has two purposes:
|
|
# - being sourced by systemd timers to setup the backup before running restic_backup.sh
|
|
# - being sourced in a user's shell to work directly with restic commands e.g.
|
|
# $ source /etc/restic/default.env.sh
|
|
# $ restic snapshots
|
|
# Thus you don't have to provide all the arguments like
|
|
# $ restic --repo ... --password-file ...
|
|
|
|
# shellcheck source=etc/restic/_global.env.sh
|
|
. "{{ INSTALL_PREFIX }}/etc/restic/_global.env.sh"
|
|
|
|
# Envvars below will override those in _global.env.sh if present.
|
|
|
|
export RESTIC_REPOSITORY="b2:<b2-repo-name>" # *EDIT* fill with your repo name
|
|
|
|
# What to backup. Colon-separated paths e.g. to different mountpoints "/home:/mnt/usb_disk".
|
|
# To backup only your home directory, set "/home/your-user"
|
|
export RESTIC_BACKUP_PATHS="" # *EDIT* fill conveniently with one or multiple paths
|
|
|
|
|
|
# Example below of how to dynamically add a path that is mounted e.g. external USB disk.
|
|
# restic does not fail if a specified path is not mounted, but it's nicer to only add if they are available.
|
|
#test -d /mnt/media && RESTIC_BACKUP_PATHS+=" /mnt/media"
|
|
|
|
# A tag to identify backup snapshots.
|
|
export RESTIC_BACKUP_TAG=systemd.timer
|
|
|
|
# Retention policy - How many backups to keep.
|
|
# See https://restic.readthedocs.io/en/stable/060_forget.html?highlight=month#removing-snapshots-according-to-a-policy
|
|
export RESTIC_RETENTION_HOURS=1
|
|
export RESTIC_RETENTION_DAYS=14
|
|
export RESTIC_RETENTION_WEEKS=16
|
|
export RESTIC_RETENTION_MONTHS=18
|
|
export RESTIC_RETENTION_YEARS=3
|
|
|
|
# Optional extra space-separated arguments to restic-backup.
|
|
# Example: Add two additional exclude files to the global one in RESTIC_PASSWORD_FILE.
|
|
#RESTIC_BACKUP_EXTRA_ARGS="--exclude-file /path/to/extra/exclude/file/a --exclude-file /path/to/extra/exclude/file/b"
|
|
# Example: exclude all directories that have a .git/ directory inside it.
|
|
#RESTIC_BACKUP_EXTRA_ARGS="--exclude-if-present .git"
|