OpenSourceArk/socks5-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Readme

Browse Source 
Update latest related and minor changes
This commit is contained in:
Sergey Bogatyrets
2023-03-13 01:21:47 +03:00
committed by GitHub
parent 902be14132
commit 246dd0bc11
1 changed files with 21 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -3,21 +3,21 @@
![Latest tag from master branch](https://github.com/serjs/socks5-server/workflows/Latest%20tag%20from%20master%20branch/badge.svg) ![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) ![Release tag](https://github.com/serjs/socks5-server/workflows/Release%20tag/badge.svg)
Simple socks5 server using go-socks5 with authentication options Simple socks5 server using go-socks5 with authentication, allowed ips list and destination FQDNs filtering
## Start container with proxy # 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=<PROXY_USER> \
-e PROXY_PASSWORD=<PROXY_PASSWORD> \
-e ALLOWED_DEST_FQDN=<REGEX_PATTERN> \
serjs/go-socks5-proxy
```
Leave `PROXY_USER` and `PROXY_PASSWORD` empty for skip authentication options while running socks5 server. ```docker run -d --name socks5 -p 1080:1080 -e PROXY_USER=<PROXY_USER> -e PROXY_PASSWORD=<PROXY_PASSWORD> serjs/go-socks5-proxy```
## List of all supported config parameters - 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| |ENV variable|Type|Default|Description|
|------------|----|-------|-----------| |------------|----|-------|-----------|
@@ -25,25 +25,26 @@ Leave `PROXY_USER` and `PROXY_PASSWORD` empty for skip authentication options wh
|PROXY_PASSWORD|String|EMPTY|Set proxy password for auth, used with PROXY_USER| |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| |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_DEST_FQDN|String|EMPTY|Allowed destination address regular expression pattern. Default allows all.|
|TZ|String|UTC|Set Timezone like in many common Operation Systems|
|ALLOWED_IPS|String|Empty|Set allowed IP's that can connect to proxy, separator `,`| |ALLOWED_IPS|String|Empty|Set allowed IP's that can connect to proxy, separator `,`|
`ALLOWED_IPS` parameter is not included in `serjs/go-socks5-proxy` image.\
You can build your image with: # Build your own image:
`docker-compose -f docker-compose.build.yml up -d`\ `docker-compose -f docker-compose.build.yml up -d`\
Just don't forget to set parameters in the `.env` file. Just don't forget to set parameters in the `.env` file.
## Test running service # Test running service
Without authentication Assuming that you are using container on 1080 host docker port
```curl --socks5 <docker host ip>:1080 http://ifcfg.co``` - result must show docker host ip (for bridged network) ## Without authentication
```curl --socks5 <docker host ip>:1080 https://ifcfg.co``` - result must show docker host ip (for bridged network)
or or
```docker run --rm curlimages/curl:7.65.3 -s --socks5 <docker host ip>:1080 http://ifcfg.co``` ```docker run --rm curlimages/curl:7.65.3 -s --socks5 <docker host ip>:1080 https://ifcfg.co```
With authentication - result must show docker host ip (for bridged network) ## With authentication
```curl --socks5 <docker host ip>:1080 -U <PROXY_USER>:<PROXY_PASSWORD> http://ifcfg.co``` ```curl --socks5 <docker host ip>:1080 -U <PROXY_USER>:<PROXY_PASSWORD> http://ifcfg.co```
@@ -51,7 +52,7 @@ or
```docker run --rm curlimages/curl:7.65.3 -s --socks5 <PROXY_USER>:<PROXY_PASSWORD>@<docker host ip>:1080 http://ifcfg.co``` ```docker run --rm curlimages/curl:7.65.3 -s --socks5 <PROXY_USER>:<PROXY_PASSWORD>@<docker host ip>:1080 http://ifcfg.co```
## Authors # Authors
* **Sergey Bogayrets** * **Sergey Bogayrets**