mirror of
https://github.com/offen/docker-volume-backup.git
synced 2024-11-10 00:30:29 +01:00
8a64da4b0b
* feat: asym encryption * tests * docs * refactor * logs & errs * comment * Update docs/reference/index.md use correct env var in example Co-authored-by: Frederik Ring <frederik.ring@gmail.com> * Update cmd/backup/encrypt_archive.go use errwarp for initial error msg Co-authored-by: Frederik Ring <frederik.ring@gmail.com> * rm orphaned code in encryption functions * inline readArmoredKeys * naming -GPG_PUBLIC_KEYS- to GPG_PUBLIC_KEY_RING * add eror handling for closing func * use dynamically generated keys for testing * rm explicit gpg-agent start * rm unnecessary private_key export * pass PASSPHRASE correctly to the decryption command * capture defer errors * log & err msg --------- Co-authored-by: Frederik Ring <frederik.ring@gmail.com>
422 lines
9.7 KiB
Markdown
422 lines
9.7 KiB
Markdown
---
|
|
title: Recipes
|
|
layout: default
|
|
nav_order: 4
|
|
---
|
|
|
|
# Recipes
|
|
{: .no_toc }
|
|
|
|
This doc lists configuration for some real-world use cases that you can copy and paste to tweak and match your needs.
|
|
|
|
1. TOC
|
|
{: toc }
|
|
|
|
## Backing up to AWS S3
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
|
|
AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Backing up to Filebase
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
AWS_ENDPOINT: s3.filebase.com
|
|
AWS_S3_BUCKET_NAME: filebase-bucket
|
|
AWS_ACCESS_KEY_ID: FILEBASE-ACCESS-KEY
|
|
AWS_SECRET_ACCESS_KEY: FILEBASE-SECRET-KEY
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Backing up to MinIO
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
AWS_ENDPOINT: minio.example.com
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID: MINIOACCESSKEY
|
|
AWS_SECRET_ACCESS_KEY: MINIOSECRETKEY
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
|
|
## Backing up to MinIO (using Docker secrets)
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
AWS_ENDPOINT: minio.example.com
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID_FILE: /run/secrets/minio_access_key
|
|
AWS_SECRET_ACCESS_KEY_FILE: /run/secrets/minio_secret_key
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
secrets:
|
|
- minio_access_key
|
|
- minio_secret_key
|
|
|
|
volumes:
|
|
data:
|
|
|
|
secrets:
|
|
minio_access_key:
|
|
# ... define how secret is accessed
|
|
minio_secret_key:
|
|
# ... define how secret is accessed
|
|
```
|
|
|
|
## Backing up to WebDAV
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
WEBDAV_URL: https://webdav.mydomain.me
|
|
WEBDAV_PATH: /my/directory/
|
|
WEBDAV_USERNAME: user
|
|
WEBDAV_PASSWORD: password
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Backing up to SSH
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
SSH_HOST_NAME: server.local
|
|
SSH_PORT: 2222
|
|
SSH_USER: user
|
|
SSH_REMOTE_PATH: /data
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
- /path/to/private_key:/root/.ssh/id_rsa
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Backing up to Azure Blob Storage
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
AZURE_STORAGE_CONTAINER_NAME: backup-container
|
|
AZURE_STORAGE_ACCOUNT_NAME: account-name
|
|
AZURE_STORAGE_PRIMARY_ACCOUNT_KEY: Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Backing up to Dropbox
|
|
|
|
See [Dropbox Setup](../how-tos/set-up-dropbox.md) on how to get the appropriate environment values.
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
DROPBOX_REFRESH_TOKEN: REFRESH_KEY # replace
|
|
DROPBOX_APP_KEY: APP_KEY # replace
|
|
DROPBOX_APP_SECRET: APP_SECRET # replace
|
|
DROPBOX_REMOTE_PATH: /Apps/my-test-app/some_subdir # replace
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Backing up locally
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
BACKUP_FILENAME: backup-%Y-%m-%dT%H-%M-%S.tar.gz
|
|
BACKUP_LATEST_SYMLINK: backup-latest.tar.gz
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
- ${HOME}/backups:/archive
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Backing up to AWS S3 as well as locally
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
|
|
AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
- ${HOME}/backups:/archive
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Running on a custom cron schedule
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
# take a backup on every hour
|
|
BACKUP_CRON_EXPRESSION: "0 * * * *"
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
|
|
AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Rotating away backups that are older than 7 days
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
|
|
AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
|
|
BACKUP_FILENAME: backup-%Y-%m-%dT%H-%M-%S.tar.gz
|
|
BACKUP_PRUNING_PREFIX: backup-
|
|
BACKUP_RETENTION_DAYS: 7
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Encrypting your backups symmetrically using GPG
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
|
|
AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
|
|
GPG_PASSPHRASE: somesecretstring
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Encrypting your backups asymmetrically using GPG
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
|
|
AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
|
|
GPG_PUBLIC_KEY_RING: |
|
|
-----BEGIN PGP PUBLIC KEY BLOCK-----
|
|
|
|
D/cIHu6GH/0ghlcUVSbgMg5RRI5QKNNKh04uLAPxr75mKwUg0xPUaWgyyrAChVBi
|
|
...
|
|
-----END PGP PUBLIC KEY BLOCK-----
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Using mysqldump to prepare the backup
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
database:
|
|
image: mariadb:latest
|
|
labels:
|
|
- docker-volume-backup.archive-pre=/bin/sh -c 'mysqldump -psecret --all-databases > /tmp/dumps/dump.sql'
|
|
volumes:
|
|
- data:/tmp/dumps
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
environment:
|
|
BACKUP_FILENAME: db.tar.gz
|
|
BACKUP_CRON_EXPRESSION: "0 2 * * *"
|
|
volumes:
|
|
- ./local:/archive
|
|
- data:/backup/data:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock
|
|
|
|
volumes:
|
|
data:
|
|
```
|
|
|
|
## Running multiple instances in the same setup
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data_1` and `data_2` volumes here
|
|
backup_1: &backup_service
|
|
image: offen/docker-volume-backup:v2
|
|
environment: &backup_environment
|
|
BACKUP_CRON_EXPRESSION: "0 2 * * *"
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
|
|
AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
|
|
# Label the container using the `data_1` volume as `docker-volume-backup.stop-during-backup=service1`
|
|
BACKUP_STOP_DURING_BACKUP_LABEL: service1
|
|
volumes:
|
|
- data_1:/backup/data-1-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
backup_2:
|
|
<<: *backup_service
|
|
environment:
|
|
<<: *backup_environment
|
|
# Label the container using the `data_2` volume as `docker-volume-backup.stop-during-backup=service2`
|
|
BACKUP_CRON_EXPRESSION: "0 3 * * *"
|
|
BACKUP_STOP_DURING_BACKUP_LABEL: service2
|
|
volumes:
|
|
- data_2:/backup/data-2-backup:ro
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
|
|
volumes:
|
|
data_1:
|
|
data_2:
|
|
```
|
|
|
|
## Running as a non-root user
|
|
|
|
```yml
|
|
version: '3'
|
|
|
|
services:
|
|
# ... define other services using the `data` volume here
|
|
backup:
|
|
image: offen/docker-volume-backup:v2
|
|
user: 1000:1000
|
|
environment:
|
|
AWS_S3_BUCKET_NAME: backup-bucket
|
|
AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
|
|
AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
|
|
volumes:
|
|
- data:/backup/my-app-backup:ro
|
|
|
|
volumes:
|
|
data:
|
|
```
|