socks5-server/README.md

34 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2017-04-25 00:03:06 +03:00
# go-socks5-proxy
2016-12-20 13:13:22 +03:00
2018-06-13 22:53:27 +03:00
Simple socks5 server using go-socks5 with or without auth
2016-12-20 13:13:22 +03:00
2018-04-24 21:00:14 +03:00
## Start container with proxy
2016-12-20 13:13:22 +03:00
2018-04-24 21:00:14 +03:00
```docker run -d --name socks5 -p 1080:1080 -e PROXY_USER=<PROXY_USER> -e PROXY_PASSWORD=<PROXY_PASSWORD> serjs/go-socks5-proxy```
2017-04-25 00:03:06 +03:00
2018-04-24 21:00:14 +03:00
For auth-less mode just do not pass envrionment variables `PROXY_USER` and `PROXY_PASSWORD`.
2018-06-13 22:53:27 +03:00
## 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|
2018-04-24 21:00:14 +03:00
## Test running service
Without auth
```curl --socks5 <docker host ip>:1080 http://ifcfg.co``` - result must show docker host ip (for bridged network)
With auth
```curl --socks5 --user <PROXY_USER:<PROXY_PASSWORD> <docker host ip>: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.