From da651b5fee2184307438aac9dd8340bc54aeb8b1 Mon Sep 17 00:00:00 2001
From: BroodjeAap <david@broodjeaap.net>
Date: Fri, 30 Dec 2022 16:12:37 +0000
Subject: [PATCH] added proxy and proxy pool sections to readme

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 todo.md   |  2 --
 2 files changed, 47 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e6d6b8e..ec7c959 100644
--- a/README.md
+++ b/README.md
@@ -80,6 +80,53 @@ services:
       retries: 5
 ```
 
+### Proxy
+
+Go-Watch has some basic proxy support, using the config we can point Go-Watch to a proxy server:  
+```
+proxy:
+  proxy_url: http://proxy.com:1234
+```
+
+When using the docker image, the `HTTP_PROXY` and `HTTPS_PROXY` environment variables can also be used:  
+```
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: base
+    container_name: go-watch
+    environment:
+    - HTTP_PROXY=http://proxy.com:1234
+    - HTTPS_PROXY=http://proxy.com:1234
+```
+#### Proxy pools
+
+Proxy 'pools' are not directly supported by Go-Watch, but can still be set up by using a proxy, for example with [Squid](http://www.squid-cache.org/):  
+```
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: base
+    container_name: go-watch
+    environment:
+    - HTTP_PROXY=http://squid_proxy:3128
+    - HTTPS_PROXY=http://squid_proxy:3128
+  squid_proxy:
+    image: sameersbn/squid:latest
+    volumes:
+    - /path/to/squid.conf:/etc/squid/squid.conf
+```
+
+And in the `squid.conf` the proxy pool would be defined like this:  
+```
+cache_peer proxy1.com parent 3128 0 round-robin no-query
+cache_peer proxy2.com parent 3128 0 round-robin no-query
+```
+
 ### Authentication
 
 Go-Watch doesn't have built in authentication, but we can use a reverse proxy for that, for example through Traefik:  
diff --git a/todo.md b/todo.md
index c109221..a3b3778 100644
--- a/todo.md
+++ b/todo.md
@@ -1,6 +1,4 @@
 # Todo
-- proxy readme
-    - proxy pool readme
 - comments
 - run/fix staticcheck
 - add browserless support ?