marcel/backup-rclone
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

README.md aktualisiert

Browse source 
Fixed typo, extended README
This commit is contained in:
Michael Rodin 2023-09-02 18:19:55 +00:00
parent e648606a11
commit a49681e17a
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -14,14 +14,19 @@ This script can create a backup of directories on a remote server. In addition t
```
git clone https://git.marcelsite.com/marcel/backup-rclone.git
cd backup-rclone
chmod u+x backup-rclone.sh
```
## Usage
The RClone share name is currently hardcoded as "backup:", so you need to create a share called "backup".
To make a backup, you need to put a `.backup.env`-file into the root of the directory you want to back up.
An example file is inside of this repository. You need to edit the file first to yur liking:
An example file is inside of this repository. You need to edit the file first to your liking:
* enctype: if you want the files to be encrypted pre-upload. (gpg: encrypt for RECIPIENT_ID; plain: don't encrypt)
* include: (optional) directories/files to consider for a backup
* exclude: (optional) directories/files to never backup, even if in include
* backdir: root directory on the remote server (e.g. backup:pc1/documents)
* hashdb: path to the database file on the remote server
* RECIPIENT_ID: (only if enctype="gpg") the ID of the recipient's public key
* RECIPIENT_ID: (only if enctype="gpg") the ID of the recipient's public key
After creating the file, you can start a backup with `./backup-rclone.sh <directory name>`, e.g.: `./backup-rclone.sh /home/user/documents` (a .backup.env file need st obe in that directory!).