|
|
@@ -9,21 +9,21 @@ Container image for creating cron-scheduled backups with [borg backup](https://w
|
|
|
- Focus on local backups. For cloud backups [restic](https://restic.net/) offers as alternative more options.
|
|
|
|
|
|
## Installation & Setup
|
|
|
- - Build:
|
|
|
+ 1. Build:
|
|
|
- Run `docker compose build` to build the container image from `./build/Dockerfile`
|
|
|
- - Configuration:
|
|
|
+ 2. Configuration:
|
|
|
- `cp .env.template .env `
|
|
|
- Adapt `.env`, parameters are explained in the template file
|
|
|
- - Init the backup archive:
|
|
|
+ 3. Init the backup archive:
|
|
|
- `docker exec --rm -it borg bash -c "borg init --encryption repokey-blake2"`
|
|
|
- - Start the container:
|
|
|
+ 4. Start the container:
|
|
|
- `docker compose up -d`
|
|
|
- - Upgrade:
|
|
|
+ 5. Upgrade:
|
|
|
- Alpine and Borg versions are hard-coded in `docker-compose.yml`.
|
|
|
- [Borg Release Notes](https://github.com/borgbackup/borg/releases) should be consulted prior to upgrades.
|
|
|
|
|
|
## Preparation for disaster recovery
|
|
|
-Very important: The following files MUST be stored along with the backup to enable decryption of the backup data
|
|
|
+Very important! Following files MUST be stored along with the backup to enable decryption of the backup data:
|
|
|
- `.env`-file file containing the passphrase
|
|
|
- Keyfiles, stored in ./data/.config/borg/keys/
|
|
|
|
|
|
@@ -36,7 +36,7 @@ Very important: The following files MUST be stored along with the backup to enab
|
|
|
6. Start the backup container: `docker-compose up -d`
|
|
|
|
|
|
## Monitoring
|
|
|
- - Status and statistics are sent to Prometheus Push-Gateway using a simple bash-script and curl
|
|
|
+Status and statistics are sent to Prometheus Push-Gateway using a simple bash-script and curl
|
|
|
|
|
|
## Security considerations
|
|
|
- This container will run with root priveliges in order to access all data for backup.
|
