commit 84a57417b2ee7b8ec6f9bcb5c4a8a340087d40cf
parent 65af6e29558d5d816d71910a68a1d0c42e814077
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Sat, 29 Jun 2024 21:34:09 +0200
feat: transform readme to markdown
Diffstat:
| D | README | | | 39 | --------------------------------------- |
| A | README.md | | | 42 | ++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 42 insertions(+), 39 deletions(-)
diff --git a/README b/README
@@ -1,39 +0,0 @@
-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.
-
-Detailed description can be found here:
-https://www.jayvii.de/posts/backups/
-
-Uses well-known tools, following the UNIX-philosophy:
-- rsnc https://rsync.samba.org/
-- 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
-
-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"
-
-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
-to 12 backup versions before the first backup is overwritten.
diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+# Encrypted Backup via rsync and gocryptfs
+
+Please send patches or remarks to
+[jayvii[AT]posteo[DOT]de](mailto:jayvii[AT]posteo[DOT]de)
+
+Atomic and encrypted backups made easy with a simple bash script.
+
+Detailed description can be found
+[on my blog](https://www.jayvii.de/posts/backups/)
+
+Uses well-known tools, following the UNIX-philosophy:
+
+* [rsnc](https://rsync.samba.org/)
+* [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:
+
+```bash
+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:
+
+```bash
+./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
+to 12 backup versions before the first backup is overwritten.
