|
@@ -4,16 +4,23 @@ Container image for creating cron-scheduled backups with [borg backup](https://w
|
|
|
## Borg key features
|
|
## Borg key features
|
|
|
- Space efficient storage through deduplication and compression.
|
|
- Space efficient storage through deduplication and compression.
|
|
|
- Fast backup runs and pruning of old backups.
|
|
- Fast backup runs and pruning of old backups.
|
|
|
- - Encryption to allow backup storage in insecure offsite locations.
|
|
|
|
|
|
|
+ - Encryption to allow backup storage in insecure offsite-locations.
|
|
|
- FUSE mount support for easy recovery.
|
|
- FUSE mount support for easy recovery.
|
|
|
- - Focus on local backups. (For cloud backups [restic](https://restic.net/) offers more options.)
|
|
|
|
|
|
|
+ - Focus on local backups. For cloud backups [restic](https://restic.net/) offers as alternative more options.
|
|
|
|
|
|
|
|
## Installation & Setup
|
|
## Installation & Setup
|
|
|
- - Build: Run `docker compose build` to build the container image from `./build/Dockerfile`
|
|
|
|
|
- - Configuration: `cp .env.template .env ` and adapt `.env` (parameters are explained in the template file)
|
|
|
|
|
- - Init the backup archive: `docker exec --rm -it borg bash -c "borg init --encryption repokey-blake2"`
|
|
|
|
|
- - Start the container: `docker compose up -d`
|
|
|
|
|
- - 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.
|
|
|
|
|
|
|
+ - Build:
|
|
|
|
|
+ - Run `docker compose build` to build the container image from `./build/Dockerfile`
|
|
|
|
|
+ - Configuration:
|
|
|
|
|
+ - `cp .env.template .env `
|
|
|
|
|
+ - Adapt `.env`, parameters are explained in the template file
|
|
|
|
|
+ - Init the backup archive:
|
|
|
|
|
+ - `docker exec --rm -it borg bash -c "borg init --encryption repokey-blake2"`
|
|
|
|
|
+ - Start the container:
|
|
|
|
|
+ - `docker compose up -d`
|
|
|
|
|
+ - 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
|
|
## 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: The following files MUST be stored along with the backup to enable decryption of the backup data
|
