From 00f235946128838f64afad8417accf3049ad16a5 Mon Sep 17 00:00:00 2001 From: Rajan Patel Date: Tue, 22 Feb 2022 02:00:26 -0500 Subject: [PATCH] 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 --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 4650b40..492efdf 100644 --- 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: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 This section lists configuration for some real-world use cases that you can mix and match according to your needs.