A Bash script to generate a tar.gz backup of a folder, with an option to automatically upload the backup file to a cloud service using rclone.
List of cloud/storage providers currently supported by rclone can be found here.
Latest version: 1.2.0 (changelog)
- Generate a tar.gz backup file of a folder.
- Automatic upload of backup file to a cloud service using rclone.
- Exclude specific folders / patterns.
- Remove local backup file once upload is finished.
- Pushbullet notifications.
- rclone, configured with at least one remote (for using the upload feature).
- A Pushbullet account (for receiving Pushbullet notifications).
Configuration can be set on the script file under the "Configuration" section,
or using command-line arguments (will override configuration that's set on on the script).
Usage: backup [-n <name>] [-s <path>] [-e <pattern>]... [-u <path>] [-r] [-v] <path-to-backup>
Options:
-n <name> Sets the tar.gz file name [default: "backup"]
-s <path> Path to which the generated backup file will be saved to [default: current working directory]
-e <pattern> Exclude a pattern (specific files / folders) from being backed up
-u <path> rclone path to which the backup file will be uploaded to (not providing one will skip the upload process)
-p <API key> Sends a Pushbullet notification once backup is done
-r Removes local copy of backup file after it's been uploaded
-y Skip warnings (Warnings require user input to continue by default)
-v Uses '-v' option when running tar and rclone
Commands:
-h Displays this help message and exists.
Examples:
backup "/home/user/important_stuff"
backup -u "GDrive:/Backups" -r -y -p "XXXXXXXXXXXXXXXX" "/home/user/important_stuff/"
backup -n "important-stuff-backup" -s "/home/user/backups" -e "*.pdf" -e "important_stuff/dont_backup_this_folder" "/home/user/important_stuff/"
Q: Why use tar and not gzip for backups?
A: The tar format can store symlinks and file permissions, whereas the zip format can't.
Q: I have a Pushbullet account. Where do I find my API key?
A: Go to your Pushbullet account's settings page, and click the "Create Access Token" button.
Q: I found a bug, or have an idea for a feature. How can I help?
A: Feel free to open an issue and post your issue / suggestion.