79 lines
2.2 KiB
Markdown
79 lines
2.2 KiB
Markdown
# Backup client
|
|
|
|
## Parameters and defaults
|
|
|
|
All configuration is to be placed inside the `backups` dict.
|
|
|
|
```
|
|
# Settings for all backup related timers.
|
|
jobs:
|
|
retention:
|
|
# Can be used to enable/disable the job
|
|
enabled: true
|
|
# Time this job runs on, random by default
|
|
OnCalendar: "hh:mm"
|
|
run:
|
|
# Can be used to enable/disable the job
|
|
enabled: true
|
|
# Time this job runs on, random by default
|
|
OnCalendar: "hh:mm"
|
|
check:
|
|
# Can be used to enable/disable the job
|
|
enabled: true
|
|
# Time this job runs on, random by default
|
|
OnCalendar: "hh:mm"
|
|
export:
|
|
# Can be used to enable/disable the job
|
|
enabled: false
|
|
# Time this job runs on, random by default
|
|
OnCalendar: "hh:mm"
|
|
|
|
# backend specific settings
|
|
backends:
|
|
# restic specific settings
|
|
restic:
|
|
# url of the restic repository
|
|
url: '/var/backup-client/restic'
|
|
# repository type musst be 'local'
|
|
repo_type: 'local'
|
|
|
|
# Mode in which the backup is taken. One of the following:
|
|
#
|
|
# vm-via-hypervisor: backup a vm via restic on the hypervisor. Saves config on the host
|
|
# hypervisor-restic: backup its vms via restic
|
|
# standalone-restic: use restic on the target itself to save a backup to a backup location (TODO)
|
|
mode: vm-via-hypervisor
|
|
|
|
# Allows backups to be skipped
|
|
enabled: True
|
|
|
|
# How many copies per time intervall should be kept?
|
|
# Note that this is ignored in vm-via-hypervisor mode because the vm host settings are used for all vms
|
|
retention:
|
|
hours: 12
|
|
days: 14
|
|
weeks: 16
|
|
months: 12
|
|
years: 3
|
|
|
|
# Settings for the export task
|
|
export:
|
|
# list of all remote destinations the backup should be exported to
|
|
destinations: []
|
|
# every element of this list describes an export target
|
|
# - user: root
|
|
# host: localhost
|
|
# remotepath: /
|
|
# type: rsync
|
|
# port: 22
|
|
# key: "/etc/backup-client/id_ed25519"
|
|
|
|
# keys are strings with glob patterns of files to be excluded. Value musst be true to enable the exclude, false to disable it
|
|
# Only supportet in restic based backups
|
|
exclude_files: {}
|
|
|
|
# Keys are strings with glob patterns of files to be included. Value musst be true to enable the include, false to disable it
|
|
# Only supportet in restic based backups
|
|
# Ignored in vm-via-hypervisor mode
|
|
include_files: {}
|
|
```
|