From 2d33041af0d1309ea1c939291e488b39180e3097 Mon Sep 17 00:00:00 2001 From: Sergey Bogatyrets Date: Wed, 13 Jun 2018 22:53:27 +0300 Subject: [PATCH] Add app params list to readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 483b6c6..8ff1cc8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # go-socks5-proxy -Simple socks5 server using go-socks5 with or without auth. +Simple socks5 server using go-socks5 with or without auth ## Start container with proxy @@ -8,6 +8,14 @@ Simple socks5 server using go-socks5 with or without auth. For auth-less mode just do not pass envrionment variables `PROXY_USER` and `PROXY_PASSWORD`. +## List of all supported config parameters + +|ENV variable|Type|Default|Description| +|------------|----|-------|-----------| +|PROXY_USER|String|EMPTY|Set proxy user (also required existed PROXY_PASS)| +|PROXY_PASSWORD|String|EMPTY|Set proxy password for auth, used with PROXY_USER| +|PROXY_PORT|String|1080|Set listen port for application| + ## Test running service Without auth