Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dannote committed Sep 22, 2016
1 parent 2ae1cf1 commit 7bd3c72
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
# socks-nginx-module

Sample usage:
An nginx_http_proxy_module fork with SOCKS5 support

## Building

`nginx` >= **1.9.1** is supported.

```bash
sudo apt-get install git build-essential zlib1g-dev libpcre3 libpcre3-dev unzip

git clone https://github.com/dannote/socks-nginx-module
wget http://nginx.org/download/nginx-1.9.15.tar.gz

tar -xzvf nginx-1.9.15.tar.gz

cd nginx-1.9.15

# See http://nginx.org/en/docs/configure.html for more configuration options
./configure --add-module=../socks-nginx-module

make
sudo make install
```

## Configuring

Sample configuration:

```
location / {
Expand All @@ -22,7 +47,7 @@ location / {

All [ngx_http_proxy_module](http://nginx.org/en/docs/http/ngx_http_proxy_module.html) directives are supported.

##socks_tunnel_header
### socks_tunnel_header

As nginx HTTP parser doesn't support HTTP CONNECT method, a special header can be set to indicate tunnel connection.

Expand Down

0 comments on commit 7bd3c72

Please sign in to comment.