From 25d277c364878d83d4311f480e772ca36d05da6e Mon Sep 17 00:00:00 2001 From: Sergey Bogatyrets Date: Tue, 27 Aug 2019 18:08:35 +0300 Subject: [PATCH] Update readme, fix #10 syntax for newer curl versions --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 295a395..dd2f885 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # go-socks5-proxy -Simple socks5 server using go-socks5 with or without auth +Simple socks5 server using go-socks5 with authentication options ## Start container with proxy ```docker run -d --name socks5 -p 1080:1080 -e PROXY_USER= -e PROXY_PASSWORD= serjs/go-socks5-proxy``` -For auth-less mode just do not pass envrionment variables `PROXY_USER` and `PROXY_PASSWORD`. +Leave `PROXY_USER` and `PROXY_PASSWORD` empty for skip authentication options while running socks5 server. ## List of all supported config parameters @@ -14,17 +14,25 @@ For auth-less mode just do not pass envrionment variables `PROXY_USER` and `PROX |------------|----|-------|-----------| |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| +|PROXY_PORT|String|1080|Set listen port for application inside docker container| ## Test running service -Without auth +Without authentication ```curl --socks5 :1080 http://ifcfg.co``` - result must show docker host ip (for bridged network) -With auth +or -```curl --socks5 --user : :1080 http://ifcfg.co``` - result must show docker host ip (for bridged network) +```docker run --rm curlimages/curl:7.65.3 -s --socks5 :1080``` + +With authentication - result must show docker host ip (for bridged network) + +```curl --socks5 --user : :1080 http://ifcfg.co``` + +or + +```docker run --rm curlimages/curl:7.65.3 -s --socks5 :@:1080``` ## Authors