From 63a3492547250abc5c059796b56f8a4b3184e52b Mon Sep 17 00:00:00 2001 From: dgtlmoon Date: Sat, 15 May 2021 18:13:00 +1000 Subject: [PATCH] Re #49 Re #60 - Adding more information about proxy setup to README.md --- README.md | 17 ++++++++++------- docker-compose.yml | 8 ++++++++ 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6a3ea02f..667f23a6 100644 --- a/README.md +++ b/README.md @@ -79,16 +79,19 @@ Just some examples ### Proxy -A proxy for ChangeDectection.io can be configured by setting environment variables. +A proxy for ChangeDectection.io can be configured by setting environment the +`HTTP_PROXY`, `HTTPS_PROXY` variables. -For example -``` -$ export HTTP_PROXY="socks5h://10.10.1.10:1080" -$ export HTTPS_PROXY="socks5h://10.10.1.10:1080" +`NO_PROXY` exclude list can be specified by following `"localhost,192.168.0.0/24"` + +as `docker run` with `-e` -# An exclude list (useful for notifcation URLs above) can be specified by following -$ export NO_PROXY="localhost,192.168.0.0/24" ``` +docker run -d --restart always -e HTTPS_PROXY="socks5h://10.10.1.10:1080" -p "127.0.0.1:5000:5000" -v datastore-volume:/datastore --name changedetection.io dgtlmoon/changedetection.io +``` + +With `docker-compose`, see the `Proxy support example` in docker-compose.yml. + For more information see https://docs.python-requests.org/en/master/user/advanced/#proxies ### Notes diff --git a/docker-compose.yml b/docker-compose.yml index 6a189081..8f910c4f 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -5,6 +5,14 @@ services: hostname: changedetection.io volumes: - changedetection-data:/datastore + + # Proxy support example. +# environment: +# - HTTP_PROXY="socks5h://10.10.1.10:1080" +# - HTTPS_PROXY="socks5h://10.10.1.10:1080" + # An exclude list (useful for notifcation URLs above) can be specified by following +# - NO_PROXY="localhost,192.168.0.0/24" + ports: - 5000:5000 restart: always