95 lines
2.4 KiB
YAML
95 lines
2.4 KiB
YAML
name: dbackup
|
|
help: differential backup using restic
|
|
version: 0.1.0
|
|
|
|
environment_variables:
|
|
- name: BACKUP_EXCLUDE
|
|
help: path to file of excludes
|
|
- name: BACKUP_INCLUDE
|
|
help: path to directory of includes
|
|
- name: BACKUP_SETTINGS
|
|
help: path to default settings file
|
|
- name: BACKUP_PASSWORD
|
|
help: path to default settings file
|
|
- name: BACKUP_SERVER
|
|
help: URL of Restic rest server
|
|
- name: BACKUP_DIR
|
|
help: Backup Directory
|
|
- name: BACKUP_MOUNT_POINT
|
|
help: mount point of source if mounted external to host
|
|
|
|
args:
|
|
- name: source
|
|
help: source directory to be backed up, default is $PWD
|
|
- name: target
|
|
help: "target directory for backup"
|
|
|
|
flags:
|
|
- long: --password
|
|
short: -p
|
|
arg: password
|
|
help: repo password (or file path) for backup repository
|
|
- long: --remote
|
|
short: -r
|
|
help: backup to a remote machine
|
|
- long: --server
|
|
arg: url
|
|
help: url of restic rest server
|
|
- long: --init
|
|
help: initialize repo (default is backup)
|
|
- long: --snap
|
|
help: list repo snapshots
|
|
- long: --view
|
|
short: -v
|
|
help: mount snapshot for viewing (default is BACKUP_MOUNT or /opt/backup/view)
|
|
- long: --view-path
|
|
help: set custom mount point path for viewing of snapshot, --view not required if set
|
|
arg: path
|
|
- long: --prune
|
|
arg: prune
|
|
help: prune repo (default is backup). true for default prune or path to prune settings
|
|
- long: --password
|
|
short: -p
|
|
arg: password
|
|
help: repo password (or file path) for backup repository
|
|
- long: --settings
|
|
short: -s
|
|
arg: syaml
|
|
help: path to settings file (yaml). Keys are same as long
|
|
- long: --host
|
|
short: -h
|
|
arg: thost
|
|
help: host on remote to target to receive backup
|
|
- long: --shost
|
|
arg: shost
|
|
help: remote to host of source
|
|
- long: --user
|
|
short: -u
|
|
arg: tuser
|
|
help: user on remote host
|
|
- long: --suser
|
|
arg: suser
|
|
help: remote user on source host
|
|
- long: --sshcfg
|
|
arg: sshcfg
|
|
help: path to sshcfg file
|
|
- long: --options
|
|
short: -o
|
|
arg: options
|
|
help: additional options (restic or rsync)
|
|
- long: --include_file
|
|
short: -i
|
|
arg: include
|
|
help: include file
|
|
- long: --exclude_file
|
|
short: -e
|
|
arg: exclude
|
|
help: exclude file
|
|
- long: --dir
|
|
short: -d
|
|
help: append source directory path to target directory
|
|
|
|
examples:
|
|
- backup -p password . /target/dir
|
|
- backup -s /path/to/settings/yaml/file
|