https://github.com/rune1979/rclone-script-templates
https://github.com/rune1979/rclone-script-templates
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rune1979/rclone-script-templates
- Owner: rune1979
- Created: 2021-03-02T21:51:31.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-30T08:32:47.000Z (almost 2 years ago)
- Last Synced: 2024-08-13T07:15:54.397Z (8 months ago)
- Language: Shell
- Size: 69.3 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - rune1979/rclone-script-templates - (Shell)
README
[](https://gitpod.io/#https://github.com/rune1979/rclone-script-templates)
# rclone-script-templates
Based on the the rclone_jobber.sh https://github.com/wolfv6/rclone_jobber this is
modified script templates for sync with archive, retreival of files in archive
and backup (copy) of directories.
This repo basically consists of three files; **backup.sh**, **sync.sh** and **restore_from_sync_archive.sh**.
There are some examples of use in the **/example** dir.
Basic understanding of rclone is a good idea, and they have a really lightweight
and easy to understand documentation: https://rclone.org/docs/
These scripts are made for my Raspberry Pi backup server. If you by some coincidence are interested
in trying to make a Raspberry Pi backup server. You may read more about it here: https://thehotelhero.com/rclone-setup-on-raspberry-pi
## backup.sh
The backup can have 9 parameters for carrying out backups and removal of old backups. In contrast to
the "sync.sh" this script will make a full copy of source on each backup. (costly on bandwidth and resources)
**The 9 parameters:**
* source: remote:source/path
* dest: remote:backup/path
* date_for_backup: day of the month to make a full backup ex. 01
* del_after: How many days back to keep monthly backups (delete everything older than x day ex. 90) except the below..
* keep_mnt: Keep these backup months in a dir called old_dir ex. 01 or 01,04,07,10(comma seperated)
* del_all_after: Will delete everything older than x days in the old_dir. Ex. 365
* job_name: The name of the current job
* option: Optional could be rclone hooks ex. --dry-run
* email: Notify this email if something goes wrong
You need to update the default email address in the "set vars" section, to your own and you need the abillity to use sendmail (or you can change that part)
in the /example dir there is an example of setting up a backup job. Ususally you would then setup a cron job (crontab) to run this file once a day.
*There is no script for restore of a backup, as this is just a one line copy command in rclone.*
## sync.sh
sync.sh is an incremental backup and more light weight aproach to backup, it keeps track of changes in individual files and folders
and only backs up the the old versions of changed files. So, (depending on the "retention" time) if a employee
asks for a file version 20 days ago (they may have made unrecoverable changes or deleted the file) you can reestablish
the older version in their filesystem for them (with restore_from_sync_archive.sh).
**The sync.sh has 6 parameters:**
* source: remote:source/path
* dest: remote:backup/path
* job_name: The name of the current job
* retention: How many days back to keep old files
* option: Optional could be rclone hooks ex. --dry-run
* email: notify this email if something goes wrong
*In the /example dir there is an example.*
## restore_from_sync_archive.sh
The restore sync script only has **four parameters:**
* list_source: In this case the backup dir is the source.
* pre_dest: Destination is where to recover the file to.
* job_name="file_recovery" # Change to some thing
* options="" # Set any rclone hooks
*There is also an example of this scripts execution*