Skip to content

Commit 9dafa66

Browse files
committed
update examples #none
1 parent be79cc8 commit 9dafa66

File tree

2 files changed

+30
-9
lines changed

2 files changed

+30
-9
lines changed

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ services:
1919
image: ghcr.io/lawndoc/stack-back:<version>
2020
env_file:
2121
- stack-back.env
22+
environment:
23+
- AUTO_DETECT_ALL: True
2224
volumes:
2325
- /var/run/docker.sock:/tmp/docker.sock:ro
2426
- cache:/cache # Persistent restic cache (greatly speeds up all restic operations)
@@ -28,18 +30,14 @@ services:
2830
2931
```yaml
3032
web:
31-
image: some_image
32-
labels:
33-
stack-back.volumes: true # Enables backup of the volumes below
33+
image: some_image # Backs up the volumes below
3434
volumes:
3535
- media:/srv/media
3636
- /srv/files:/srv/files
3737
mysql:
38-
image: mysql:9
39-
labels:
40-
stack-back.mysql: true # Enables stateful backup using mysqldump
38+
image: mysql:9 # Performs stateful backup using mysqldump
4139
volumes:
42-
- mysql:/var/lib/mysql
40+
- mysql:/var/lib/mysql # Only SQL dump is backed up
4341
```
4442
4543
[Documentation](https://stack-back.readthedocs.io)
@@ -64,6 +62,7 @@ Restic-specific environment variables can be found in the [restic documentation]
6462
stack-back.env
6563

6664
```bash
65+
AUTO_BACKUP_ALL=True
6766
RESTIC_REPOSITORY=s3:s3.us-east-1.amazonaws.com/bucket_name
6867
RESTIC_PASSWORD=thisdecryptsyourbackupsdontloseit
6968
AWS_ACCESS_KEY_ID=<your access key id>
@@ -78,6 +77,29 @@ RESTIC_KEEP_YEARLY=3
7877
CRON_SCHEDULE="0 1 * * *"
7978
```
8079

80+
## Advanced configuration (container labels)
81+
82+
You can also use `stack-back` container labels for granular control over which volumes get backed up.
83+
84+
```yaml
85+
web:
86+
image: some_image
87+
labels:
88+
- stack-back.volumes.exclude: files # host mount substring matching
89+
volumes:
90+
- media:/srv/media # will be backed up
91+
- /srv/files:/srv/files # will NOT be backed up
92+
mysql:
93+
image: mysql:9
94+
labels:
95+
- stack-back.mysql: False # don't perform database dump backup
96+
- stack-back.volumes: False # don't back up any volumes for this container either
97+
volumes:
98+
- mysql:/var/lib/mysql
99+
```
100+
101+
Detailed documentation on compose labels can be found in the [stack-back documentation](https://stack-back.readthedocs.io/en/latest/guide/configuration.html#compose-labels)
102+
81103
## The `rcb` command
82104

83105
Everything is controlled using the [`rcb` command line tool](./src/) from this repo.

stack-back.env.template

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
# DON'T COMMIT THIS FILE IF YOU MODIFY IN DEV
2-
31
# DOCKER_HOST=unix://tmp/docker.sock
42
# DOCKER_TLS_VERIFY=1
53
# DOCKER_CERT_PATH=''
64

75
# SWARM_MODE=
86
INCLUDE_PROJECT_NAME=false
97
EXCLUDE_BIND_MOUNTS=false
8+
AUTO_BACKUP_ALL=true
109

1110
RESTIC_REPOSITORY=/restic_backups
1211
RESTIC_PASSWORD=thisdecryptsyourbackupsdontloseit

0 commit comments

Comments
 (0)