amd/backup.sh
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

updating readme

Browse source
This commit is contained in:
Andrew Davidson 2021-07-15 21:11:57 -07:00
parent 00a45d80a5
commit 9be12f79b9
Signed by: amd
GPG key ID: 17AF8F2A49CF25C6
1 changed files with 29 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
readme.md
View file

@ -1,6 +1,4 @@
```bash ```bash
#!/usr/bin/env bash
print_logo () { print_logo () {
cat <<'EOF' cat <<'EOF'
_ _ _ _ _ _
@ -9,8 +7,10 @@ cat <<'EOF'
| |_) | (_| | (__| <| |_| | |_) |\__ \ | | | | |_) | (_| | (__| <| |_| | |_) |\__ \ | | |
|_.__/ \__,_|\___|_|\_\\__,_| .__(_)___/_| |_| |_.__/ \__,_|\___|_|\_\\__,_| .__(_)___/_| |_|
|_| |_|
A wrapper around restic to help control configuration.
EOF EOF
# Copyright (c) 2020 Andrew Davidson # Copyright (c) 2021 Andrew Davidson
} }
print_help () { print_help () {
@ -19,13 +19,35 @@ print_help () {
backup.sh 'command' 'destination' backup.sh 'command' 'destination'
Supported Commands: Supported Commands:
init - intiialize a new backup repository
backup - initiate a backup of the home folder to the destination backup - initiate a backup of the home folder to the destination
list - list backups on the destination check - check repository for consistency
snapshots - list backups on the destination
prune - prune old backups on the destination prune - prune old backups on the destination
stats - print statistics about the backup repository
help - print this help
Required Configuration:
\$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.repo
- Define the repository path in this file
\$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.pwd
- Define the repository password in this file
\$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.paths
- list of paths to be backed up
\$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.exclude
- list of paths to be excluded
\$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.keys
- OPTIONAL: bash exports of required keys for s3/b2 backups
\$XDG_DATA_HOME/backup.sh/\$DESTINATION/\$DESTINATION.log
- empty file for logging
Supported destinations:
royal - local borg/SFTP backup to Royal
wasabi - remote restic backup to Wasabi
""" """
} }
``` ```