Compare commits

..

1 Commits

Author SHA1 Message Date
John Lancaster
e17894e49c added docker sdk to dependencies 2024-06-15 15:49:34 -05:00
6 changed files with 16 additions and 110 deletions

View File

@@ -2,52 +2,23 @@
Purpose: Purpose:
> [!WARNING]
> This behvior does not work on the `resticprofile` branch
- Wrap `restic` with the ability to start/stop Docker containers - Wrap `restic` with the ability to start/stop Docker containers
- Send updates to Loki server - Send updates to Loki server
## Installation ## Environment Variables
### Include in Repo Recommended to put these in the relevant `~/.bashrc` file
From a parent repo, add this one as a submodule: | Env Variable | Description |
|---------------------|--------------------------------------------------------------------------------------------|
```shell | `HOSTNAME` | Network hostname of where the backup is running. Used to tag the backups in restic |
git submodule add https://gitea.john-stream.com/john/restic-scripts | `BACKUP_DIR` | Directory to back up |
``` | `RESTIC_REPOSITORY` | Directory for the restic repository. This is usually on a mount point made from Proxmox |
| `RESTIC_PASSWORD` | Password for the restic repository |
Then add this to the `docker-compose.yml` file of the parent. | `LOKI_URL` | Push URL for Loki. Should include the port and end with something like `/loki/api/v1/push` |
```yaml
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 ## Loki Updates
> [!WARNING]
> This doesn't currently work on the `resticprofile` branch
Updates sent to Loki will have the following labels: Updates sent to Loki will have the following labels:
| Label | Description | | Label | Description |
@@ -57,28 +28,16 @@ Updates sent to Loki will have the following labels:
## Usage ## Usage
Check snapshots
```shell ```shell
docker compose exec backup resticprofile snapshots python -m restic.snapshots
``` ```
Dry-run a backup To stop docker containers before the backup and start them again afterwards, use the `--project` and `--services` flags.
```shell ```shell
docker compose exec backup resticprofile --dry-run backup python -m restic.backup --tag manual --project joplin --services app,db
``` ```
Check crontab entry in container
```shell ```shell
docker compose exec backup cat /var/spool/cron/crontabs/root python -m restic.prune
```
### Crond
Crond command when scheduled using `resticprofile schedule --all`
```shell
cd /resticprofile && /usr/bin/resticprofile --no-ansi --config /etc/resticprofile/profiles.yaml --name default backup
``` ```

View File

@@ -1,16 +0,0 @@
services:
backup:
image: creativeprojects/resticprofile
entrypoint: '/bin/sh'
command:
- -c
- 'resticprofile-schedule.sh && crond -f'
env_file:
- .env
hostname: ${HOSTNAME}
volumes:
- ./restic-profile.yaml:/etc/resticprofile/profiles.yaml:ro
- ./resticprofile-schedule.sh:/usr/local/bin/resticprofile-schedule.sh:ro
- ./key:/etc/resticprofile/key:ro
- ${BACKUP_DIR}:${BACKUP_DIR}:ro
- ${RESTIC_REPOSITORY}:${RESTIC_REPOSITORY}:rw

View File

@@ -12,4 +12,4 @@ authors = [
license = { file = "LICENSE" } license = { file = "LICENSE" }
requires-python = ">=3.10" requires-python = ">=3.10"
dependencies = ["rich", "requests", "click"] dependencies = ["rich", "requests", "click", "docker"]

View File

@@ -2,4 +2,5 @@ uv
ruff ruff
rich rich
requests requests
click click
docker

View File

@@ -1,29 +0,0 @@
global:
scheduler: crond
default:
base-dir: ${BACKUP_DIR}
repository: local:${RESTIC_REPOSITORY}
password-file: key
initialize: true
backup:
source: ./
exclude-caches: true
one-file-system: true
schedule: "*:00"
schedule-permission: system
check-after: true
tag:
- resticprofile
retention:
after-backup: true
before-backup: false
prune: true
tag:
- resticprofile
keep-within: 3h
keep-hourly: 72
keep-daily: 14
keep-weekly: 8
keep-monthly: 6

View File

@@ -1,9 +0,0 @@
#!/bin/sh
set -e
resticprofile unschedule > /dev/null
resticprofile schedule --all
echo "Scheduled all restic profiles"