Name
    nginx_tcp_proxy_module

Status
    This module is at its very early phase of development and
    considered highly experimental. But you're encouraged to
    test it out on your side and report any quirks that you
    experience.

    We need your help! If you find this module useful and/or
    interesting, please consider joining the development!

Version
    Release date: 2010.03.10, version 0.01

Synopsis

    http {

        listen 80;

        location /status {
            check_status;
        }
    }

    tcp {
        ...

        upstream cluster {
            # simple round-robin
            server 127.0.0.1:3306;
            server 127.0.0.1:1234;

            # ip_hash 
            #ip_hash;
            check interval=3000 rise=2 fall=5 timeout=500;
        }

        server {
            proxy_pass cluster;
        }
    }

Description
    This module actually include many modules: ngx_tcp_module,
    ngx_tcp_core_module, ngx_tcp_upstream_module, ngx_tcp_proxy_module,
    ngx_tcp_upstream_ip_hash_module. All these modules work togther to add the
    support of TCP proxy with Nginx. I alse add other features: ip_hash,
    upstream server health check, status monitor.

    The motivation of writing these modules is Nginx's high performance and
    robustness. It's more scalable in the SMP system when compared with HAProxy.


Directives

    =ngx_tcp_moodule=

    ==tcp==
    syntax: tcp {...}
    default: none
    context: main
    description: All the tcp related directives are contained in the tcp block.

    =ngx_tcp_core_moodule=

    ==server==
    syntax: server {...}
    default: none
    context: tcp
    description: All the sepcific server directives are contained in the server block.

    ==listen==
    syntax: listen address:port [ bind ]
    default: none
    context: server
    description: The same as 'http://wiki.nginx.org/NginxMailCoreModule#listen'.

    ==so_keepalive==
    syntax: so_keepalive on|off
    default: off
    context: main, server
    description: The same as
    'http://wiki.nginx.org/NginxMailCoreModule#so_keepalive'.

    ==timeout==
    syntax: timeout milliseconds
    default: 60000
    context: main, server
    description: The same as 'http://wiki.nginx.org/NginxMailCoreModule#timeout'.

    ==server_name==
    syntax: server_name name fqdn_server_host
    default: The name of the host, obtained through gethostname()
    context: tcp, server
    description: The same as
    'http://wiki.nginx.org/NginxMailCoreModule#server_name'.

    ==resolver==
    syntax: resolver address
    default: none
    context: tcp, server
    description: TODO

    ==resolver_timeout==
    syntax: resolver_timeout time
    default: 30s
    context: tcp, server
    description: Resolver timeout in seconds.


    =ngx_tcp_upstream_module=

    ==upstream==
    syntax: upstream {...}
    default: none
    context: tcp
    description: All the upstream directives are contained in this  block. The
    upstream server will be dispatch with round robin by default.

    ==server==
    syntax: server name [parameters]
    default: none
    context: upstream
    description: Most part are the same as
    'http://wiki.nginx.org/NginxHttpUpstreamModule#server'.

    ==check==
    syntax: check interval=milliseconds [fall=count] [rise=count]
    [timeout=milliseconds] 
    default: none, if parameters omitted, default parameters are 'interval=30000
    fall=5 rise=2 timeout=500'
    context: upstream
    description: Add the health check for the upstream servers.
    interval: the check request's interval time
    fall(fall_count): After fall_count check failures, the server is marked down.
    rise(rise_count): After rise_count count check success, the server is marked up.
    timeout: the check request's timeout.

    ==check_shm_size==
    syntax: check_shm_size size
    default: (number_of_upstream + 1) * pagesize
    context: tcp
    description: If you set hundreds of serveres in a upstream. The shared memory
    for health check may be not enough, you can enlarged it by this directive.

    ==check_status==
    syntax: check_status
    default: none
    context: location 
    description: display the health checking servers' status by HTTP.

    =ngx_tcp_upstream_ip_hash_module=

    ==ip_hash==
    syntax: ip_hash
    default: none
    context: upstream 
    description: the upstream server will be dispatch by ip_hash.


    =ngx_tcp_proxy_module=

    ==proxy_pass==
    syntax: proxy_pass host:port
    default: none
    context: server 
    description: proxy the request to the backend server.

    ==proxy_buffer==
    syntax: proxy_buffer size
    default: 4k
    context: tcp, server 
    description: set the proxy buffer size.

    ==proxy_connect_timeout==
    syntax: proxy_connect_timeout miliseconds
    default: 60000
    context: tcp, server 
    description: set the timeout value of connection to backends.

    ==proxy_read_timeout==
    syntax: proxy_connect_timeout miliseconds
    default: 60000
    context: tcp, server 
    description: set the timeout value of reading from backends.

    ==proxy_write_timeout==
    syntax: proxy_connect_timeout miliseconds
    default: 60000
    context: tcp, server 
    description: set the timeout value of writing to backends.


Installation
    Download the latest version of the release tarball of this module from
    http://github.com/yaoweibin/nginx_tcp_proxy_module. 

    Grab the nginx source code from nginx.net (<http://nginx.org/>), for
    example, the version 0.7.65 (see nginx compatibility), and then build
    the source with this module:

        $ wget 'http://nginx.org/download/nginx-0.7.65.tar.gz'
        $ tar -xzvf nginx-0.7.65.tar.gz
        $ cd nginx-0.7.65/
        $ patch -p1 < /path/to/nginx_tcp_proxy_module/tcp.patch

        $ ./configure --add-module=/path/to/nginx_tcp_proxy_module

        $ make
        $ make install

TODO
    *  health check, more method 

Known Issues
    *  test

See Also
    *  test 

Authors
    Weibin Yao(姚伟斌) <yaoweibin at gmail dot com>

Copyright & License
    This README template copy from agentzh(http://github.com/agentzh).

    I borrowed a lot of code from upstream and mail module from the nginx 0.7.* 
    core. This part of code is copyrighted by Igor Sysoev.

    This module is licenced under the BSD license.

    Copyright (C) 2010 by Weibin Yao <[email protected]>.

    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

        * Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.

        * Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.

        * Neither the name of the Taobao Inc. nor the names of its
        contributors may be used to endorse or promote products derived from
        this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
    TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.