jimmy
/
restic-compose-backup
mirror of https://github.com/ZettaIO/restic-compose-backup.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Einar Forselv 2019-12-03 09:43:21 +01:00
parent fc5c6cc914
commit 53a3a54e02
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -13,7 +13,7 @@ This includes both host mapped volumes and actual docker volumes.
* When backup starts a new instance of the container is created * When backup starts a new instance of the container is created
mapping in all the needed volumes. It will copy networks etc mapping in all the needed volumes. It will copy networks etc
to ensure databases can be reached to ensure databases can be reached
* Volumes are mounter to `/backup/<service_name>/<path>` * Volumes are mounted to `/backup/<service_name>/<path>`
in the backup process container. `/backup` is pushed into restic in the backup process container. `/backup` is pushed into restic
* Databases are backed up from stdin / dumps * Databases are backed up from stdin / dumps
* Cron triggers backup * Cron triggers backup
@ -36,7 +36,7 @@ version: '3'
services: services:
# The backup service # The backup service
backup: backup:
build: restic-volume-backup build: restic-compose-backup
environment: environment:
- RESTIC_REPOSITORY=<whatever restic supports> - RESTIC_REPOSITORY=<whatever restic supports>
- RESTIC_PASSWORD=hopefullyasecturepw - RESTIC_PASSWORD=hopefullyasecturepw
@ -49,7 +49,7 @@ services:
image: some_image image: some_image
# Enable volume backup with label # Enable volume backup with label
labels: labels:
restic-volume-backup.enabled: true restic-compose-backup.volumes: true
# These volumes will be backed up # These volumes will be backed up
volumes: volumes:
# Docker volume # Docker volume
@ -67,8 +67,8 @@ A simple `include` and `exclude` filter is also available.
example: example:
image: some_image image: some_image
labels: labels:
restic-volume-backup.volumes: true restic-compose-backup.volumes: true
restic-volume-backup.volumes.include: "files,data" restic-compose-backup.volumes.include: "files,data"
volumes: volumes:
# Source don't match include filter. No backup. # Source don't match include filter. No backup.
- media:/srv/media - media:/srv/media
@ -88,8 +88,8 @@ Exclude
example: example:
image: some_image image: some_image
labels: labels:
restic-volume-backup.volumes: true restic-compose-backup.volumes: true
restic-volume-backup.volumes.exclude: "media" restic-compose-backup.volumes.exclude: "media"
volumes: volumes:
# Excluded by filter # Excluded by filter
- media:/srv/media - media:/srv/media
@ -112,21 +112,21 @@ path `/backup/<service_name>/dump.sql` or similar.
mariadb: mariadb:
image: mariadb:10 image: mariadb:10
labels: labels:
restic-volume-backup.mariadb: true restic-compose-backup.mariadb: true
``` ```
```yaml ```yaml
mysql: mysql:
image: mysql:5 image: mysql:5
labels: labels:
restic-volume-backup.mysql: true restic-compose-backup.mysql: true
``` ```
```yaml ```yaml
postgres: postgres:
image: postgres image: postgres
labels: labels:
restic-volume-backup.postgres: true restic-compose-backup.postgres: true
``` ```