Skip to content

Commit 00f2359

Browse files
rpatel3001m90
andauthored
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 <[email protected]>
1 parent 0504a92 commit 00f2359

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ It handles __recurring or one-off backups of Docker volumes__ to a __local direc
2727
- [Using with Docker Swarm](#using-with-docker-swarm)
2828
- [Manually triggering a backup](#manually-triggering-a-backup)
2929
- [Update deprecated email configuration](#update-deprecated-email-configuration)
30+
- [Using a custom Docker host](#using-a-custom-docker-host)
3031
- [Recipes](#recipes)
3132
- [Backing up to AWS S3](#backing-up-to-aws-s3)
3233
- [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
321322

322323
# NOTIFICATION_LEVEL="error"
323324

325+
########### DOCKER HOST
326+
327+
# If you are interfacing with Docker via TCP you can set the Docker host here
328+
# instead of mounting the Docker socket as a volume. This is unset by default.
329+
330+
# DOCKER_HOST="tcp://docker_socket_proxy:2375"
331+
324332
########### EMAIL NOTIFICATIONS
325333

326334
# ************************************************************************
@@ -616,6 +624,15 @@ After:
616624
617625
```
618626

627+
### Using a custom Docker host
628+
629+
If you are interfacing with Docker via TCP, set `DOCKER_HOST` to the correct URL.
630+
```ini
631+
DOCKER_HOST=tcp://docker_socket_proxy:2375
632+
```
633+
634+
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.
635+
619636
## Recipes
620637

621638
This section lists configuration for some real-world use cases that you can mix and match according to your needs.

0 commit comments

Comments
 (0)