Simple README
[proxy] / README.md
1 # socks5server #
2
3 socks5server is a minimalist SOCKS5 proxy server.
4
5 ## Requirements
6
7 * C99 compiler
8 * libbsd
9 * pthread
10
11 ## Instructions
12
13 ### Compile
14
15 apt-get install build-essential libbsd
16 make
17 sudo make install
18
19 ### Configuration
20
21 * Edit /usr/local/etc/socks5server.conf
22 * You must specify `LISTEN_PORT`
23 * To make an open proxy you can use `ALLOW_ALL=1`
24 * Alternatively you can have an unlimited number of `ALLOW_HOST_<anything>=<host>`
25 * If you choose to specify a list of allowed hosts you can use DNS names or IP addresses