From 7123ccada7f16d52b533cc466485f45337edac64 Mon Sep 17 00:00:00 2001
From: John Lancaster <32917998+jsl12@users.noreply.github.com>
Date: Sat, 15 Jun 2024 15:11:26 -0500
Subject: [PATCH] added notes for the key

---
 README.md | 28 ++++++++++++++++++----------
 1 file changed, 18 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 355abbc..5835757 100644
--- a/README.md
+++ b/README.md
@@ -7,16 +7,6 @@ Purpose:
 
 ## Installation
 
-### Environment Variables
-
-Put these in `./restic-scripts/.env`, which is on the `.gitignore` list.
-
-| Env Variable        | Description                                                                             |
-| ------------------- | --------------------------------------------------------------------------------------- |
-| `BACKUP_DIR`        | Directory to back up                                                                    |
-| `RESTIC_REPOSITORY` | Directory for the restic repository. This is usually on a mount point made from Proxmox |
-| `TZ`                | Set to modify the timezone shown in the scheduler                                       |
-
 ### Include in Repo
 
 From a parent repo, add this one as a submodule:
@@ -32,6 +22,24 @@ include:
   - restic-scripts/docker-compose.yml
 ```
 
+### Environment Variables
+
+Put these in `./restic-scripts/.env`, which is on the `.gitignore` list.
+
+| Env Variable        | Description                                                                             |
+| ------------------- | --------------------------------------------------------------------------------------- |
+| `BACKUP_DIR`        | Directory to back up                                                                    |
+| `RESTIC_REPOSITORY` | Directory for the restic repository. This is usually on a mount point made from Proxmox |
+| `TZ`                | Set to modify the timezone shown in the scheduler                                       |
+
+### Key file
+
+The password needs to be stored in `./restic-scripts/key`. Make sure it has the right (secure) permissions.
+
+```shell
+sudo chown root:root ./restic-scripts/key && sudo chmod 600 ./restic-scripts/key
+```
+
 ## Loki Updates
 
 Updates sent to Loki will have the following labels: