High Performance Web Platform Based on Nginx and LuaJIT
Go to file
Johnny Wang 8b119bceb7
win32: upgraded deps zlib to 1.3.1.
2024-07-09 17:27:25 +08:00
.github Refresh check-spelling workflow (#865) 2022-09-23 20:41:48 +08:00
FreeBSD/www/openresty [FreeBSD]: first step of port 2012-08-09 22:41:37 +04:00
clients/js chore: fix spelling 2021-07-23 20:03:20 +08:00
demo/Blog renamed ngx_openresty to openresty. 2016-01-25 14:33:53 -08:00
doc travis: added spelling check workflow. (#811) 2022-01-29 20:46:37 +08:00
html updated the default index page and 50x error page. (#949) 2024-01-04 10:57:01 +08:00
patches feature: more patch for balancer_pool_max_retry. 2024-07-09 11:41:35 +08:00
specs doc: fixed misspelling. (#693) 2021-05-07 17:32:19 +08:00
t tests: update tests. 2024-06-26 14:44:22 +08:00
util win32: upgraded deps zlib to 1.3.1. 2024-07-09 17:27:25 +08:00
.gitattributes ensure that GitHub tags us as using the C language. 2015-11-25 11:40:32 +08:00
.gitignore feature: added a patch for the nginx core to add the "local=/path/to/resolv.conf" option to the standard "resolver" config directive. 2018-03-16 16:19:19 -07:00
.travis.yml tests: fixed failed test introduced by commit ad33f56e91. 2024-01-13 10:16:10 +08:00
COPYRIGHT COPYRIGHT: added licenses of openssl, zlib, and pcre. 2017-07-12 16:02:02 -07:00
Makefile tests: sanity.t: renamed to t/000-sanity.t and added '.' in lib path. 2019-09-25 23:04:18 -07:00
README.markdown doc: updated the copyright year to 2019. 2019-01-04 10:05:05 -08:00
valgrind.suppress feature: added a patch for the nginx core to add the "local=/path/to/resolv.conf" option to the standard "resolver" config directive. 2018-03-16 16:19:19 -07:00

README.markdown

Name

OpenResty - Turning Nginx into a Full-Fledged Scriptable Web Platform

Table of Contents

Description

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 Yichun Zhang (agentzh).

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.

The homepage for this project is on openresty.org.

For Users

Visit the download page on the openresty.org web site to download the latest bundle tarball, and follow the installation instructions in the installation page.

For Bundle Maintainers

The bundle's source is at the following git repository:

https://github.com/openresty/openresty

To reproduce the bundle tarball, just do

make

at the top of the bundle source tree.

Please note that you may need to install some extra dependencies, like perl, dos2unix, and mercurial. On Fedora 22, for example, installing the dependencies is as simple as running the following commands:

sudo dnf install perl dos2unix mercurial

Back to TOC

Additional Features

In additional to the standard nginx core features, this bundle also supports the following:

Back to TOC

resolv.conf parsing

syntax: resolver address ... [valid=time] [ipv6=on|off] [local=on|off|path]

default: -

context: http, stream, server, location

Similar to the resolver directive in standard nginx core with additional support for parsing additional resolvers from the resolv.conf file format.

When local=on, the standard path of /etc/resolv.conf will be used. You may also specify arbitrary path to be used for parsing, for example: local=/tmp/test.conf.

When local=off, parsing will be disabled (this is the default).

This feature is not available on Windows platforms.

Back to TOC

Mailing List

You're very welcome to join the English OpenResty mailing list hosted on Google Groups:

https://groups.google.com/group/openresty-en

The Chinese mailing list is here:

https://groups.google.com/group/openresty

Back to TOC

Report Bugs

You're very welcome to report issues on GitHub:

https://github.com/openresty/openresty/issues

Back to TOC

Copyright & License

The bundle itself is licensed under the 2-clause BSD license.

Copyright (c) 2011-2019, Yichun "agentzh" Zhang (章亦春) agentzh@gmail.com, OpenResty Inc.

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.

Back to TOC