Wavyzz/docker-volume-backup
2
0
Fork 0
mirror of https://github.com/offen/docker-volume-backup.git synced 2025-12-06 09:38:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation should not mention deprecated version declaration

Browse Source
This commit is contained in:
Frederik Ring
2025-06-07 16:01:50 +02:00
parent 06bb25c980
commit 47a9c13b54
10 changed files with 0 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/how-tos/automatically-prune-old-backups.md
View File

@@ -14,8 +14,6 @@ Be aware that this mechanism looks at __all files in the target bucket or archiv
In case you need to use a target that cannot be used exclusively for your backups, you can configure `BACKUP_PRUNING_PREFIX` to limit which files are considered eligible for deletion: In case you need to use a target that cannot be used exclusively for your backups, you can configure `BACKUP_PRUNING_PREFIX` to limit which files are considered eligible for deletion:
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:

2
docs/how-tos/handle-file-uploads-using-third-party-tools.md
View File

@@ -20,8 +20,6 @@ RUN apk add rsync
Using this image, you can now omit configuring any of the supported storage backends, and instead define your own mechanism in a `docker-volume-backup.copy-post` label: Using this image, you can now omit configuring any of the supported storage backends, and instead define your own mechanism in a `docker-volume-backup.copy-post` label:
```yml ```yml
version: '3'
services: services:
backup: backup:
image: your-custom-image image: your-custom-image

2
docs/how-tos/replace-deprecated-backup-from-snapshot.md
View File

@@ -11,8 +11,6 @@ Starting with version 2.15.0, the `BACKUP_FROM_SNAPSHOT` feature has been deprec
If you need to prepare your sources before the backup is taken, use `archive-pre`, `archive-post` and an intermediate volume: If you need to prepare your sources before the backup is taken, use `archive-pre`, `archive-post` and an intermediate volume:
```yml ```yml
version: '3'
services: services:
my_app: my_app:
build: . build: .

6
docs/how-tos/run-custom-commands.md
View File

@@ -28,8 +28,6 @@ the `docker-volume-backup` container as shown in the Quickstart example.
Taking a database dump using `mysqldump` would look like this: Taking a database dump using `mysqldump` would look like this:
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
database: database:
@@ -56,8 +54,6 @@ In case you use `EXEC_LABEL` together with configuration mounted from `conf.d` i
Else, schedules that do not specify an `EXEC_LABEL` will still trigger commands on all containers with such labels, no matter whether they specify `docker-volume-backup.exec-label` or not. Else, schedules that do not specify an `EXEC_LABEL` will still trigger commands on all containers with such labels, no matter whether they specify `docker-volume-backup.exec-label` or not.
```yml ```yml
version: '3'
services: services:
database: database:
image: mariadb image: mariadb
@@ -87,8 +83,6 @@ By default the backup command is executed by the user provided by the container'
It is possible to specify a custom user that is used to run commands in dedicated labels with the format `docker-volume-backup.[step]-[pre|post].user`: It is possible to specify a custom user that is used to run commands in dedicated labels with the format `docker-volume-backup.[step]-[pre|post].user`:
```yml ```yml
version: '3'
services: services:
gitea: gitea:
image: gitea/gitea image: gitea/gitea

2
docs/how-tos/run-multiple-schedules.md
View File

@@ -10,8 +10,6 @@ nav_order: 11
Multiple backup schedules with different configuration can be configured by mounting an arbitrary number of configuration files (using the `.env` format) into `/etc/dockervolumebackup/conf.d`: Multiple backup schedules with different configuration can be configured by mounting an arbitrary number of configuration files (using the `.env` format) into `/etc/dockervolumebackup/conf.d`:
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:

2
docs/how-tos/set-container-timezone.md
View File

@@ -12,8 +12,6 @@ As the image is designed to be as small as possible, additional timezone data is
In case you want to run your cron rules in your local timezone (respecting DST and similar), you can mount your Docker host's `/etc/timezone` and `/etc/localtime` in read-only mode: In case you want to run your cron rules in your local timezone (respecting DST and similar), you can mount your Docker host's `/etc/timezone` and `/etc/localtime` in read-only mode:
```yml ```yml
version: '3'
services: services:
backup: backup:
image: offen/docker-volume-backup:v2 image: offen/docker-volume-backup:v2

2
docs/how-tos/set-up-notifications.md
View File

@@ -12,8 +12,6 @@ parent: How Tos
To send out email notifications on failed backup runs, provide SMTP credentials, a sender and a recipient: To send out email notifications on failed backup runs, provide SMTP credentials, a sender and a recipient:
```yml ```yml
version: '3'
services: services:
backup: backup:
image: offen/docker-volume-backup:v2 image: offen/docker-volume-backup:v2

2
docs/how-tos/stop-containers-during-backup.md
View File

@@ -17,8 +17,6 @@ By default, any container that is labeled `docker-volume-backup.stop-during-back
In case you need more fine grained control about which containers should be stopped (e.g. when backing up multiple volumes on different schedules), you can set the `BACKUP_STOP_DURING_BACKUP_LABEL` environment variable and then use the same value for labeling: In case you need more fine grained control about which containers should be stopped (e.g. when backing up multiple volumes on different schedules), you can set the `BACKUP_STOP_DURING_BACKUP_LABEL` environment variable and then use the same value for labeling:
```yml ```yml
version: '3'
services: services:
app: app:
# definition for app ... # definition for app ...

2
docs/index.md
View File

@@ -32,8 +32,6 @@ Code and documentation for `v1` versions are found on [this branch][v1-branch].
Add a `backup` service to your compose setup and mount the volumes you would like to see backed up: Add a `backup` service to your compose setup and mount the volumes you would like to see backed up:
```yml ```yml
version: '3'
services: services:
volume-consumer: volume-consumer:
build: build:

34
docs/recipes/index.md
View File

@@ -15,8 +15,6 @@ This doc lists configuration for some real-world use cases that you can copy and
## Backing up to AWS S3 ## Backing up to AWS S3
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -36,8 +34,6 @@ volumes:
## Backing up to Filebase ## Backing up to Filebase
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -58,8 +54,6 @@ volumes:
## Backing up to MinIO ## Backing up to MinIO
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -81,8 +75,6 @@ volumes:
## Backing up to MinIO (using Docker secrets) ## Backing up to MinIO (using Docker secrets)
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -112,8 +104,6 @@ secrets:
## Backing up to WebDAV ## Backing up to WebDAV
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -134,8 +124,6 @@ volumes:
## Backing up to SSH ## Backing up to SSH
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -157,8 +145,6 @@ volumes:
## Backing up to Azure Blob Storage ## Backing up to Azure Blob Storage
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -180,8 +166,6 @@ volumes:
See [Dropbox Setup](../how-tos/set-up-dropbox.md) on how to get the appropriate environment values. See [Dropbox Setup](../how-tos/set-up-dropbox.md) on how to get the appropriate environment values.
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -202,8 +186,6 @@ volumes:
## Backing up locally ## Backing up locally
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -223,8 +205,6 @@ volumes:
## Backing up to AWS S3 as well as locally ## Backing up to AWS S3 as well as locally
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -245,8 +225,6 @@ volumes:
## Running on a custom cron schedule ## Running on a custom cron schedule
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -268,8 +246,6 @@ volumes:
## Rotating away backups that are older than 7 days ## Rotating away backups that are older than 7 days
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -292,8 +268,6 @@ volumes:
## Encrypting your backups symmetrically using GPG ## Encrypting your backups symmetrically using GPG
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -314,8 +288,6 @@ volumes:
## Encrypting your backups asymmetrically using GPG ## Encrypting your backups asymmetrically using GPG
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup:
@@ -341,8 +313,6 @@ volumes:
## Using mariadb-dump/mysqldump to prepare the backup ## Using mariadb-dump/mysqldump to prepare the backup
```yml ```yml
version: '3'
services: services:
database: database:
image: mariadb:latest image: mariadb:latest
@@ -367,8 +337,6 @@ volumes:
## Running multiple instances in the same setup ## Running multiple instances in the same setup
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data_1` and `data_2` volumes here # ... define other services using the `data_1` and `data_2` volumes here
backup_1: &backup_service backup_1: &backup_service
@@ -402,8 +370,6 @@ volumes:
## Running as a non-root user ## Running as a non-root user
```yml ```yml
version: '3'
services: services:
# ... define other services using the `data` volume here # ... define other services using the `data` volume here
backup: backup: