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