mirror of
https://github.com/offen/docker-volume-backup.git
synced 2024-11-22 21:30:28 +01:00
Add DOCKER_HOST documentation (#74)
* add DOCKER_HOST documentation * add which endpoints are required for DOCKER_HOST * Update README.md Co-authored-by: Frederik Ring <frederik.ring@gmail.com>
This commit is contained in:
parent
0504a92a1f
commit
00f2359461
17
README.md
17
README.md
@ -27,6 +27,7 @@ It handles __recurring or one-off backups of Docker volumes__ to a __local direc
|
|||||||
- [Using with Docker Swarm](#using-with-docker-swarm)
|
- [Using with Docker Swarm](#using-with-docker-swarm)
|
||||||
- [Manually triggering a backup](#manually-triggering-a-backup)
|
- [Manually triggering a backup](#manually-triggering-a-backup)
|
||||||
- [Update deprecated email configuration](#update-deprecated-email-configuration)
|
- [Update deprecated email configuration](#update-deprecated-email-configuration)
|
||||||
|
- [Using a custom Docker host](#using-a-custom-docker-host)
|
||||||
- [Recipes](#recipes)
|
- [Recipes](#recipes)
|
||||||
- [Backing up to AWS S3](#backing-up-to-aws-s3)
|
- [Backing up to AWS S3](#backing-up-to-aws-s3)
|
||||||
- [Backing up to Filebase](#backing-up-to-filebase)
|
- [Backing up to Filebase](#backing-up-to-filebase)
|
||||||
@ -321,6 +322,13 @@ You can populate below template according to your requirements and use it as you
|
|||||||
|
|
||||||
# NOTIFICATION_LEVEL="error"
|
# NOTIFICATION_LEVEL="error"
|
||||||
|
|
||||||
|
########### DOCKER HOST
|
||||||
|
|
||||||
|
# If you are interfacing with Docker via TCP you can set the Docker host here
|
||||||
|
# instead of mounting the Docker socket as a volume. This is unset by default.
|
||||||
|
|
||||||
|
# DOCKER_HOST="tcp://docker_socket_proxy:2375"
|
||||||
|
|
||||||
########### EMAIL NOTIFICATIONS
|
########### EMAIL NOTIFICATIONS
|
||||||
|
|
||||||
# ************************************************************************
|
# ************************************************************************
|
||||||
@ -616,6 +624,15 @@ After:
|
|||||||
NOTIFICATION_URLS=smtp://me:secret@posteo.de:587/?fromAddress=no-reply@example.com&toAddresses=you@example.com
|
NOTIFICATION_URLS=smtp://me:secret@posteo.de:587/?fromAddress=no-reply@example.com&toAddresses=you@example.com
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Using a custom Docker host
|
||||||
|
|
||||||
|
If you are interfacing with Docker via TCP, set `DOCKER_HOST` to the correct URL.
|
||||||
|
```ini
|
||||||
|
DOCKER_HOST=tcp://docker_socket_proxy:2375
|
||||||
|
```
|
||||||
|
|
||||||
|
In case you are using a socket proxy, it must support `GET` and `POST` requests to the `/containers` endpoint. If you are using Docker Swarm, it must also support the `/services` endpoint.
|
||||||
|
|
||||||
## Recipes
|
## Recipes
|
||||||
|
|
||||||
This section lists configuration for some real-world use cases that you can mix and match according to your needs.
|
This section lists configuration for some real-world use cases that you can mix and match according to your needs.
|
||||||
|
Loading…
Reference in New Issue
Block a user