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

Add app params list to readme

Browse Source
This commit is contained in:
Sergey Bogatyrets
2018-06-13 22:53:27 +03:00
parent 678a8cc192
commit 2d33041af0
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,6 +1,6 @@
# go-socks5-proxy # go-socks5-proxy
Simple socks5 server using go-socks5 with or without auth. Simple socks5 server using go-socks5 with or without auth
## Start container with proxy ## Start container with proxy
@@ -8,6 +8,14 @@ Simple socks5 server using go-socks5 with or without auth.
For auth-less mode just do not pass envrionment variables `PROXY_USER` and `PROXY_PASSWORD`. For auth-less mode just do not pass envrionment variables `PROXY_USER` and `PROXY_PASSWORD`.
## 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|
## Test running service ## Test running service
Without auth Without auth