forked from yaoweibin/nginx_tcp_proxy_module
/
README
107 lines (79 loc) · 3.4 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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!
Commit bit can be freely delivered at your request ;)
Synopsis
tcp {
...
upstream cluster {
# simple round-robin
server 127.0.0.1:3306;
server 127.0.0.1:1234;
# ip_hash
#ip_hash;
}
server {
proxy_connect_timeout 2s;
proxy_pass cluster;
}
}
Description
* TODO
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
* test script
* health check
* failover
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 <yaoweibin@gmail.com>.
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.