Update readme, add CI status
This commit is contained in:
parent
b298a6d003
commit
e3f7a71ac3
19
README.md
19
README.md
@ -1,9 +1,16 @@
|
|||||||
# socks5-server
|
# go-socks5-proxy
|
||||||
Simple socks5 server using go-socks5 with hardcoded auth
|
[![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 <image_name> .```
|
# Start container with proxy
|
||||||
|
```docker run -d --name socks5-proxy -p 1080:1080 -e PROXY_USER=<PROXY_USER> -e PROXY_PASSWORD=<PROXY_PASSWORD> serjs/go-socks5-proxy```
|
||||||
|
|
||||||
Then
|
where
|
||||||
```docker run -d -p 1080:1080 -e PROXY_USER=<PROXY_USER -e PROXY_PASSWORD=<PROXY_PASSWORD <image_name>```
|
|
||||||
|
```<PROXY_USER>``` - username to authenticate
|
||||||
|
|
||||||
|
```<PROXY_PASSWORD>``` - password to authenticate
|
||||||
|
|
||||||
|
# Test running service
|
||||||
|
```curl --socks5 <docker machine ip>:1080 -U <PROXY_USER>:<PROXY_PASSWORD> https://ifcfg.me``` - result must show docker host ip (for bridged network)
|
Loading…
Reference in New Issue
Block a user