Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/serjs/socks5-server

Last synced: 15 days ago
JSON representation

Host: GitHub
URL: https://github.com/serjs/socks5-server
Owner: serjs
Created: 2016-12-20T10:05:13.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2024-07-26T23:02:10.000Z (4 months ago)
Last Synced: 2024-08-01T03:34:09.621Z (3 months ago)
Language: Go
Size: 2.1 MB
Stars: 683
Watchers: 8
Forks: 168
Open Issues: 28
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

stars - serjs/socks5-server

README

# go-socks5-proxy

![Latest tag from master branch](https://github.com/serjs/socks5-server/workflows/Latest%20tag%20from%20master%20branch/badge.svg)
![Release tag](https://github.com/serjs/socks5-server/workflows/Release%20tag/badge.svg)

Simple socks5 server using go-socks5 with authentication, allowed ips list and destination FQDNs filtering

# Examples

- Run docker container using default container port 1080 and expose it to world using host port 1080, with auth creds

```docker run -d --name socks5 -p 1080:1080 -e PROXY_USER= -e PROXY_PASSWORD= serjs/go-socks5-proxy```

- Leave `PROXY_USER` and `PROXY_PASSWORD` empty for skip authentication options while running socks5 server, see example below

- Run docker container using specifit container port and expose it to host port 1090, without auth creds

```docker run -d --name socks5 -p 1090:9090 -e PROXY_PORT=9090 serjs/go-socks5-proxy```

# List of 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 inside docker container|
|ALLOWED_DEST_FQDN|String|EMPTY|Allowed destination address regular expression pattern. Default allows all.|
|ALLOWED_IPS|String|Empty|Set allowed IP's that can connect to proxy, separator `,`|

# Build your own image:
`docker-compose -f docker-compose.build.yml up -d`\
Just don't forget to set parameters in the `.env` file.

# Test running service

Assuming that you are using container on 1080 host docker port

## Without authentication

```curl --socks5 :1080 https://ifcfg.co``` - result must show docker host ip (for bridged network)

```docker run --rm curlimages/curl:7.65.3 -s --socks5 :1080 https://ifcfg.co```

## With authentication

```curl --socks5 :1080 -U : http://ifcfg.co```

```docker run --rm curlimages/curl:7.65.3 -s --socks5 :@:1080 http://ifcfg.co```

# Authors

* **Sergey Bogayrets**

See also the list of [contributors](https://github.com/serjs/socks5-server/graphs/contributors) who participated in this project.