openresty README

The project's README from github.com/openresty/openresty. As one markdown file: README.md.

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 (章亦春) [email protected], 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:

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

openresty (openresty/openresty)

Searching Database…

14.1K ·GitHub
Openresty
这是什么东西？OpenResty 是一个功能完备的 Web 应用服务器：它把标准的 nginx 核心、大量第三方 nginx 模块以及它们的大部分外部依赖打包成了一个软件包。
这和我自己直接装 nginx 有什么区别？打包的大部分模块都出自同一批维护者之手，因此能确保彼此兼容协作——你得到的是一个完整一致的平台，而不是自己东拼西凑地组装 nginx 的各个部件。
我怎么把它装好跑起来？从 openresty.org 的下载页面下载最新的打包压缩包，然后按照安装页面上的说明操作即可。
我需要先装别的东西吗？常规的压缩包安装不需要额外准备什么。只有当你自己从 git 源码重新制作这个压缩包时，才可能需要 perl、dos2unix 和 mercurial——在 Fedora 22 上也就是几条安装命令的事。
在所有操作系统上表现都一样吗？它可以在 Linux、macOS 和 Windows 上编译运行（仓库为这三个平台都配置了 CI 构建），但并非处处完全一致：resolv.conf 解析功能明确不支持 Windows 平台。
关于许可证有什么要知道的？这个软件包本身采用 2-clause BSD 许可证，而打包在内的第三方组件仍保留各自版权持有者的版权。
这个软件包比标准 nginx 核心多加了什么？它加入了自己的功能——比如一个增强版的 resolver 指令，可以从 resolv.conf 文件里读取额外的 DNS 解析服务器：local=on 会读取 /etc/resolv.conf，也可以把它指向任意路径。
LuaJIT 在其中扮演什么角色？OpenResty 的定位是基于 Nginx 和 LuaJIT 的高性能 Web 平台——正是 LuaJIT 让打包的 nginx 可以用脚本编程，所以才有了'把 Nginx 变成功能完备的可编程 Web 平台'这个说法。
这个项目还在活跃维护吗？是的——它从 2010 年起就托管在 GitHub 上，拥有大约 14,000 颗星，其 CI 会为 Linux、macOS 和 Windows 构建并检查这个软件包。
我实际能用它做点什么？直接在服务器内部运行的 Web 应用和 API：README 称它为功能完备的 Web 应用服务器，也就是说请求处理逻辑直接写在这个平台上，而不需要放在单独的后端里。
What are similar projects?nginx, lua-nginx-module, tengine, fasthttp, webserver, h2o, sanic, nginx-rtmp-module
Which topics is it in?web-server, nginx, lua, dns, http, bsd, c, backend, web-development, performance, api, server
Creator
openresty
Size
3 MB
Stars
14.1K
Updated
CommitOct 18Releasev1.27.1.2Oct 08
Age
16y
Commits · 90 Days