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]>
offen · Feb 22, 2022 · 00f2359 · 00f2359
1 parent 0504a92
commit 00f2359
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/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)
   - [Manually triggering a backup](#manually-triggering-a-backup)
   - [Update deprecated email configuration](#update-deprecated-email-configuration)
+  - [Using a custom Docker host](#using-a-custom-docker-host)
 - [Recipes](#recipes)
   - [Backing up to AWS S3](#backing-up-to-aws-s3)
   - [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"
 
+########### 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
 
 # ************************************************************************
@@ -616,6 +624,15 @@ After:
 NOTIFICATION_URLS=smtp://me:[email protected]:587/[email protected]&[email protected]
 ```
 
+### 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
 
 This section lists configuration for some real-world use cases that you can mix and match according to your needs.