From e3f7a71ac3ec1acbc0f65a1a6bac389231c6b65a Mon Sep 17 00:00:00 2001 From: Sergey Bogatyrets Date: Tue, 25 Apr 2017 00:03:06 +0300 Subject: [PATCH] Update readme, add CI status --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 593ebaf..56a630b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,16 @@ -# socks5-server -Simple socks5 server using go-socks5 with hardcoded auth +# go-socks5-proxy +[![CircleCI](https://circleci.com/gh/serjs/socks5-server.svg?style=shield)](https://circleci.com/gh/serjs/socks5-server) -Run +Simple socks5 server using go-socks5 with auth -```docker build -t .``` +# Start container with proxy +```docker run -d --name socks5-proxy -p 1080:1080 -e PROXY_USER= -e PROXY_PASSWORD= serjs/go-socks5-proxy``` -Then -```docker run -d -p 1080:1080 -e PROXY_USER=``` \ No newline at end of file +where + +`````` - username to authenticate + +`````` - password to authenticate + +# Test running service +```curl --socks5 :1080 -U : https://ifcfg.me``` - result must show docker host ip (for bridged network) \ No newline at end of file