openresty/README

129 lines
4.4 KiB
Plaintext

ngx_openresty is a full-fledged web application server by bundling the standard nginx core,
lots of 3rd-party nginx modules, as well as most of their external dependencies.
This bundle is maintained by us, agentzh and chaoslawful, and sponsored by
Taobao.com, Alibaba Group.
Because most of the nginx modules are developed by the bundle maintainers, it can ensure
that all these modules are played well together.
The bundled software components are copyrighted by the respective copyright holders.
A quick note to Debian and Ubuntu users:
You're recommended to install the following packages using apt-get before
installing this bundle:
apt-get install libreadline-dev libpcre3-dev libssl-dev perl
To build ngx_openresty, you need a working perl (perl 5.6.0 or better)
in your PATH environment, and then follow the following steps:
1. download the latest ngx_openresty tarball can be downloaded from
http://agentzh.org/misc/nginx/ngx_openresty-0.8.54.2.tar.gz
we will eventually migrate to the openresty.org domain.
2. and then enter the ngx_openresty-0.8.54.2/ directory,
and type the following command to configure:
./configure
by default, --prefix=/usr/local/openresty is assumed. You can
specify various options, as in
./configure --prefix=/opt/openresty \
--with-luajit \
--without-http_drizzle_module \
--with-http_iconv_module \
--with-http_postgres_module
try ./configure --help to see more options.
For Solaris, it's common to install libraries like OpenSSL to /lib,
so when it complaints about OpenSSL and you have indeed
already installed it, specify the --with-ld-opt='-L/lib' option.
3. build everything locally
make
4. install ngx_openresty into the target directory that you specified by
the --prefix option in Step 2.
make install
For bundle maintainers:
The bundle's source is at the following git repository:
https://github.com/agentzh/ngx_openresty
To reproduce the bundle tarball, just do
make
at the top of the bundle source tree.
The following packages are bundled in the 0.8.54.2 release:
LuaJIT-2.0.0-beta6
array-var-nginx-module-0.02
auth-request-nginx-module-0.2
drizzle-nginx-module-0.0.15rc9
echo-nginx-module-0.36rc2
encrypted-session-nginx-module-0.01
form-input-nginx-module-0.07rc4
headers-more-nginx-module-0.14
iconv-nginx-module-0.10rc3
libdrizzle-0.8
lua-5.1.4
memc-nginx-module-0.12rc1
nginx-0.8.54
ngx_devel_kit-0.2.17
ngx_lua-0.1.6rc2
ngx_postgres-0.8
rds-json-nginx-module-0.11rc2
redis2-nginx-module-0.06
set-misc-nginx-module-0.21
srcache-nginx-module-0.12rc2
upstream-keepalive-nginx-module-0.3
xss-nginx-module-0.03rc2
The bundle itself is licensed under the 2-clause BSD license.
Copyright (c) 2011, Taobao Inc., Alibaba Group (
http://www.taobao.com ).
Copyright (c) 2011, Yichun "agentzh" Zhang (章亦春)
<agentzh@gmail.com>.
Copyright (c) 2011, Xiaozhe "chaoslawful" Wang (王晓哲)
<chaoslawful@gmail.com>.
This module is licensed under the terms of the BSD license.
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.
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.