norgbackup/examples/norg.toml.sample

# Source Directories you would like to back up in a TOML list format
source_directories = [
    "/home/me/Music",
    "/home/me/Pictures"
]

# Repositories to back up to, in separate TOML objects
[[repositories]]
label = "A Repository"
path = "/my/backup/location"
[[repositories]]
label = "Another Respository at BorgBase"
path = "ssh://1234abcd@1234abcd.repo.borgbase.com/./repo"

# Encryption Configuration
[encryption]
# `encryption_passphrase` gets set as the `BORG_PASSPHRASE` env var
encryption_passphrase = "MyReallySecurePassword"
# I hope to add more Borg encryption env vars here in time

# Actions that are called at various times during runtime
[actions]
# "everything" means before or after every possible option for all repositories
before_everything = ["echo before everything"]
after_everything = ["echo after everything"]
# "actions" means before any action, per repository
before_actions = ["echo before actions"]
after_actions = ["echo after actions"]
# before or after the backup process per repository
before_backup = ["echo before backup"]
after_backup = ["echo after backup"]
# before or after the extract process per repository
before_extract = ["echo before extract"]
after_extract = ["echo after extract"]
# before or after the prune process per repository
before_prune = ["echo before prune"]
after_prune = ["echo after prune"]
# before or after the compact process per respository
before_compact = ["echo before compact"]
after_compact = ["echo after compact"]
# before or after the check processs per repository
before_check = ["echo before check"]
after_check = ["echo after check"]

[uptimekuma]
# The base/push url of your Uptime Kuma monitor - without the query string.
# The quenry string will be generated at run time and will change dependant on the state of your backup.
base_url = "https://uptime.kuma.url/api/push/1234abcd"

# what backup states you wish to send an alert for, defaults to Success, Failure and Running
states = ["Success","Failure", "Running"]

[binaries]
# You can set locations for borg and restic binaries if you need to
borg_bin = "/usr/local/bin/borg"
restic_bin = "/usr/local/bin/restic"