initial readme.

README.MD

@@ -0,0 +1,77 @@
+# Disaster recovery
+
+This repository contains some helper scripts to get you started with making backups to Hetzner storage box and other online storage solution.
+
+Everything is controlled by .env files. 
+
+### Files
+
+#### backup.env
+
+copy the file backup.env.sample to backup.env and start configuring it to your liking.
+
+The some important parts are:
+
+```BACKUP_PATH="/home"```  
+This is the directory you want to backup.
+
+
+``` BACKUP_EXCLUDE="backup_exclude.txt.sample" ```  
+This is the "exclude file", more on that later.
+
+```
+export LOGFILE="$LOGPATH/backup_docker.log"
+export LASTLOG="$LOGPATH/backup_docker.log.last" 
+```
+This is the logfiles where the result of the backup is saved.
+The LASTLOG contains only the result of the last backup, and will be included in the summary email. 
+
+
+```PRIVATE_KEY_FILE="./id_ed25519"```  
+The Private key used to access the storage device.
+This can be generated with the init_backup.sh script.
+You can also use an excisting file, or generate one by hand with "ssh-keygen -t ed25519"
+
+
+```REPOSITORY_URL="disaster-recovery.example.com"```  
+URL of repository server, that is where your backups are going to be saved. 
+This can ofcourse also be a IP address. 
+
+```REPOSITORY_DIR="test"```  
+A repository can host several backups, thus we define in what directory on the repository server the backups shoud be saved. 
+This MUST BE UNIQUE for each system you are making backups for.
+
+
+```REPOSITORY_USER="u000000"```  
+What user should be used to authenticate on the backup server.
+
+``` export BORG_PASSPHRASE="soe4eiCae9ohSij7Aiceesh2ZiphiHoh"```  
+This is your passphrase used to encrypt the backup.
+If you lose this, you lose EVERYTHING!
+If someone else gets this, they can potentially access all your data.
+Keep it safe and secure.
+DO NOT USE THIS AS YOUR PASSPHRASE.
+(And no, this is NOT my passphrase, it is some random garbage)
+
+### backup_exclude.txt
+
+Todo
+
+### init_backup.sh
+
+Todo
+
+### make_backup.sh
+
+Todo
+
+
+### mail_template.py
+
+Todo
+
+
+### secrets.env
+
+Todo
+