/resty5-slimline

Resty5 (slimline) - A high-performance web application server based on OpenResty, bundled with OpenSSL, PCRE, Zlib, lots of additional lua-resty modules, and an easy-to-use installer

Primary LanguageC

Name

Resty5 (Slimline) - High-performance web application framework (based on OpenResty)

Table of Contents

Description

Resty5 is a very high-performance web application framework that extends the functions and features of the highly popular OpenResty application server.

Compatability with OpenResty

Yes! Right now Resty5 is just OpenResty packaged together with most of the best third-party lua-resty-xxx modules. In the future we expect to add non-Lua modules, but our goal is to always maintain backwards-compatability with OpenResty, such that everything that works on OpenResty will also work on Resty5 (even if the reverse is not always true).

Back to TOC

Differences to OpenResty

  1. Many more Lua modules are bundled in by default
  2. The bundler is very flexible, and can be easily configured to include different modules
  3. The bundler always includes the latest releases of all packages
  4. There are differences with in the configure script (including more options) - see below

Back to TOC

Differences in the ./configure script

  1. There are more options with Resty5 than OpenResty
  2. The options are organized in a different way, with headings, more spacing and and listed alphabetically (for clarity)
  3. Configuration options are added for all the external libraries that are bundled with Resty5

Note that the Resty5 configure options is (and will remain) a superset of the OpenResty options, so no changes need to be made when switching from OpenResty to Resty5.

Back to TOC

Version features

This bundle includes:

  • All the OpenResty components
  • Almost all the lua-resty-*** modules available on Github
  • The latest sources for OpenSSL, PCRE and Zlib

When Resty5 is compiled, by default the supplied sources are used rather than the system libraries as shared libraries that are loaded at run time.

Status

  • The OpenResty code and the bundled external libraries are production-ready
  • Most of the lua-resty-*** modules are also production-ready, but Github will confirm this for each module

Back to TOC

Usage

./configure [options]
make
make install
  • Configure also compiles the shared libraries, so can take some time to complete
  • You may need to do sudo make install, depending on where you are installing and the permissions of the user

Back to TOC

Documentation

The OpenResty documentation can be found here: https://github.com/openresty/openresty

Documentation for each of the lua-resty-xxx modules can be found on their respective Github pages or websites. Google is your friend here (for now). We will add a full list later.

For now there is no documentation specific to Resty5 that is different from the above. When that changes, we will add it here.

Back to TOC

Report Bugs

You're very welcome to report issues on GitHub:

https://github.com/vision5/resty5-slimline/issues

Back to TOC

TODO

  • Add details on configuration options
  • Look for more lua-resty-xxx modules to include
  • Test all the lua-resty-xxx modules

Back to TOC

Copyright & License

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

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