commit 65af6e29558d5d816d71910a68a1d0c42e814077
parent 1aa90c40b3559e41b280d251a8f1d54d78215f71
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Sat, 27 Apr 2024 17:40:55 +0200
adjust readme
Diffstat:
| M | README | | | 20 | +++++++++++--------- |
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/README b/README
@@ -1,5 +1,7 @@
Encrypted Backup via rsync and gocryptfs
------
+========================================
+
+Please send patches or remarks to <jayvii[AT]posteo[DOT]de>
Atomic and encrypted backups made easy with a simple bash script.
@@ -11,26 +13,26 @@ Uses well-known tools, following the UNIX-philosophy:
- gocryptfs https://nuetzlich.net/gocryptfs/
Preparation
------
+===========
Initilize gocryptfs with the Backup-source directory. If you want to backup
(subdirectories of) your home-folder, do the following:
-gocryptfs \
- --init \ # initilise the volume
- --reverse \ # use "reverse mode"
- --plaintextnames \ # do not obfuscate names of files and directories
- "$HOME" # target directory. Here: our home-folder
+ gocryptfs \
+ --init \ # initilise the volume
+ --reverse \ # use "reverse mode"
+ --plaintextnames \ # do not obfuscate names of files and directories
+ "$HOME" # target directory. Here: our home-folder
This will create a .gocryptfs.reverse.conf file with the encryption meta data.
Do not lose this file or your encryption password.
Usage
------
+=====
To backup your home directory to a remote server via SSH, use following syntax:
-./backup.sh "$HOME" "user[AT]example[DOT]com"
+ ./backup.sh "$HOME" "user[AT]example[DOT]com"
Backups are stored on the remote end in the folder named after the hostname of
your source machine and the current month. If you do monthly updates, this leads
