Simple README
authorJames Bunton <jamesbunton@delx.net.au>
Tue, 22 Sep 2015 22:36:41 +0000 (08:36 +1000)
committerJames Bunton <jamesbunton@delx.net.au>
Tue, 22 Sep 2015 22:36:41 +0000 (08:36 +1000)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..ac11ba8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# socks5server #
+
+socks5server is a minimalist SOCKS5 proxy server.
+
+## Requirements
+
+* C99 compiler
+* libbsd
+* pthread
+
+## Instructions
+
+### Compile
+
+    apt-get install build-essential libbsd
+    make
+    sudo make install
+
+### Configuration
+
+* Edit /usr/local/etc/socks5server.conf
+* You must specify `LISTEN_PORT`
+* To make an open proxy you can use `ALLOW_ALL=1`
+* Alternatively you can have an unlimited number of `ALLOW_HOST_<anything>=<host>`
+* If you choose to specify a list of allowed hosts you can use DNS names or IP addresses