john/restic-scripts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added notes for the key

Browse Source
This commit is contained in:
John Lancaster
2024-06-15 14:18:08 -05:00
parent 18b53fe103
commit 81bd1006cb
1 changed files with 18 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -7,16 +7,6 @@ Purpose:
## Installation ## 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 ### Include in Repo
From a parent repo, add this one as a submodule: From a parent repo, add this one as a submodule:
@@ -32,6 +22,24 @@ include:
- restic-scripts/docker-compose.yml - 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 ## Loki Updates
Updates sent to Loki will have the following labels: Updates sent to Loki will have the following labels: