diff --git a/Changelog.md b/Changelog.md new file mode 100644 index 0000000..567e641 --- /dev/null +++ b/Changelog.md @@ -0,0 +1,15 @@ +# Changelog +All notable changes to this project will be documented in this file. + +## [Unreleased] + +## [v0.0.1] - 2018-04-24 +### Added +- Optional auth + +### Changed +- Golang vendoring +- Change Dockerfile for multistage builds with final scratch image + +### Removed +- IDE files \ No newline at end of file diff --git a/README.md b/README.md index 230f6d6..483b6c6 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,24 @@ Simple socks5 server using go-socks5 with or without auth. -# Start container with proxy -```docker run -d --name socks5 -p 1080:1080 -e PROXY_USER= -e PROXY_PASSWORD= olebedev/socks5``` +## Start container with proxy -For auth-less mode just do not pass `PROXY_USER` and `PROXY_PASSWORD`. +```docker run -d --name socks5 -p 1080:1080 -e PROXY_USER= -e PROXY_PASSWORD= serjs/go-socks5-proxy``` -# Test running service -```curl --socks5 :1080 https://ya.ru``` - result must show docker host ip (for bridged network) +For auth-less mode just do not pass envrionment variables `PROXY_USER` and `PROXY_PASSWORD`. + +## Test running service + +Without auth + +```curl --socks5 :1080 http://ifcfg.co``` - result must show docker host ip (for bridged network) + +With auth + +```curl --socks5 --user :1080 http://ifcfg.co``` - result must show docker host ip (for bridged network) + +## Authors + +* **Sergey Bogayrets** + +See also the list of [contributors](https://github.com/serjs/socks5-server/graphs/contributors) who participated in this project.