Skip to content

Commit

Permalink
Update readme, add CI status
Browse files Browse the repository at this point in the history
  • Loading branch information
serjs committed Apr 24, 2017
1 parent b298a6d commit e3f7a71
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <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
```docker run -d -p 1080:1080 -e PROXY_USER=<PROXY_USER -e PROXY_PASSWORD=<PROXY_PASSWORD <image_name>```
where

```<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)

0 comments on commit e3f7a71

Please sign in to comment.