From a49681e17ab1db65dbb5aa6bbef19780ad5dc83d Mon Sep 17 00:00:00 2001 From: Michael Rodin Date: Sat, 2 Sep 2023 18:19:55 +0000 Subject: [PATCH] README.md aktualisiert Fixed typo, extended README --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3862583..c9f385e 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file +* 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 `, e.g.: `./backup-rclone.sh /home/user/documents` (a .backup.env file need st obe in that directory!). \ No newline at end of file