diff --git a/README.md b/README.md index 2f7080d..ae5606f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ # Backrest -## https://backrest.jasper.kelinreij.duckdns.org \ No newline at end of file +## https://backrest.jasper.kelinreij.duckdns.org + +## Local Configuration - **Use if Traefik is on the same server** + +### Timezone +* TZ=America/New_York + +### Location of stacks to backup +* BACKUP_STACKS_DIR=/opt + +### Location of user's home directory +* BACKUP_HOME_DIR=/~ + +### Location to store backups +* BACKUP_DIR=/mnt/restic-usb + +### The url to use for this servevice without the https:// + +* HOST_LABEL='traefik.http.routers.backrest.rule=Host(`backrest.server.subdomain.duckdns.org`)' + +> Replace server with the server's host name, and subdomain with your duckdns subdomain + +## Remote Configuration - **Use if Traefik is on a different server** + +### **Labels are ignored in this scenerio** + +### Use a remote host yml file on the Traefik server instead. + +1. Copy remote-backrest.yml to Traefik's dynamic folder + +2. Or Paste the contents of remote-backrest.yml into an existing remote host yml file. +