diff --git a/README.md b/README.md new file mode 100644 index 0000000..3862583 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Backup-RClone +This script can create a backup of directories on a remote server. In addition to RClone's own encryption, the files can be backed up in plain text or be encrypted with GPG/PGP. + +## Dependencies +* rclone +* sqlite3 + +## Features +* Backup over RClone +* Encryption of the files +* configuration files per archive directory + +## Installation +``` +git clone https://git.marcelsite.com/marcel/backup-rclone.git +cd backup-rclone +``` + +## Usage +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: +* 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