openresty/README.markdown

Name
====

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

Table of Contents
=================

* [Name](#name)
* [Description](#description)
    * [For Users](#for-users)
    * [For Bundle Maintainers](#for-bundle-maintainers)
* [Mailing List](#mailing-list)
* [Report Bugs](#report-bugs)
* [Copyright & License](#copyright--license)

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 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](https://openresty.org/).

For Users
---------

Visit the [download page](https://openresty.org/en/download.html) on the `openresty.org` web site
to download the latest bundle tarball, and
follow the installation instructions in the [installation page](https://openresty.org/en/installation.html).

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

```bash
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:

```bash
sudo dnf install perl dos2unix mercurial
```

[Back to TOC](#table-of-contents)

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](#table-of-contents)

Report Bugs
===========

You're very welcome to report issues on GitHub:

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

[Back to TOC](#table-of-contents)

Copyright & License
===================

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

Copyright (c) 2011-2017, 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](#table-of-contents)
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00			`Name`
			`====`

renamed ngx_openresty to openresty. 2016-01-25 23:33:53 +01:00			`OpenResty - Turning Nginx into a Full-Fledged Scriptable Web Platform`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
doc: added TOC. 2014-02-19 00:35:23 +01:00			`Table of Contents`
			`=================`

			`* [Name](#name)`
			`* [Description](#description)`
			`* [For Users](#for-users)`
			`* [For Bundle Maintainers](#for-bundle-maintainers)`
			`* [Mailing List](#mailing-list)`
			`* [Report Bugs](#report-bugs)`
			`* [Copyright & License](#copyright--license)`

doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00			`Description`
			`===========`

renamed ngx_openresty to openresty. 2016-01-25 23:33:53 +01:00			`OpenResty is a full-fledged web application server by bundling the standard nginx core,`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00			`lots of 3rd-party nginx modules, as well as most of their external dependencies.`

			`This bundle is maintained 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.`

doc: updated the links to openresty.org. 2016-07-27 22:15:58 +02:00			`The homepage for this project is on [openresty.org](https://openresty.org/).`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
			`For Users`
			`---------`

doc: updated the links to openresty.org. 2016-07-27 22:15:58 +02:00			Visit the [download page](https://openresty.org/en/download.html) on the `openresty.org` web site
			`to download the latest bundle tarball, and`
			`follow the installation instructions in the [installation page](https://openresty.org/en/installation.html).`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
			`For Bundle Maintainers`
			`----------------------`

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

renamed ngx_openresty to openresty. 2016-01-25 23:33:53 +01:00			`https://github.com/openresty/openresty`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
			`To reproduce the bundle tarball, just do`

More MSYS/MinGW love. * upgraded ngx_lua to 0.9.18rc1 to support Win32 LuaJIT DLL. * upgraded lua-redis-parser to 0.11rc1 for better Win32 support. * upgraded lua-rds-parser to 0.06rc2 for better Win32 support. * upgraded ngx_rds_csv to 0.07rc1 for better Win32 support. * upgraded lua-resty-cli to 0.04rc1 for better Win32 support. * upgraded lua-resty-core to 0.1.2. * applied a patch to LuaJIT to add "!/lualib/" to the default Lua package search paths. * upgraded lua-cjson to 2.1.0.3rc2 for better Win32 support and a suppressed gcc warning. * use OpenResty's nginx tarballs extracted directly from the official nginx code repos, because we need the win32 support which is excluded in the official nginx release tarballs. Our nginx release tarballs are generated by the util/package-nginx.sh script. * added the util/package-win32.sh script to generate the Win32 OpenResty binary distribution file. * applied a patch to always enable C compiler feature tests in nginx's own build system because the MinGW gcc compiler on Win32 is also powerful enough to support advanced features like variadic macros. * added document README-win32. * util/dist-check: do a partial uninstallation before installing anything new. * added util/build-win32.sh to build OpenResty on Win32 using the MinGW/MSYS toolchain. * ./configure: added support for building on Win32 using the MinGW/MSYS toolchain. 2015-10-30 14:29:48 +01:00			```bash
			`make`
			```
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
			`at the top of the bundle source tree.`

doc: mentions the mercurial dep. 2017-07-06 21:10:18 +02:00			Please note that you may need to install some extra dependencies, like `perl`, `dos2unix`, and `mercurial`.
updated README to reflect our recent change of getting rid of Markdown::Pod. 2016-05-13 01:30:54 +02:00			`On Fedora 22, for example, installing the dependencies`
doc: documented the missing build dependencies as per #126. 2015-12-04 06:53:00 +01:00			`is as simple as running the following commands:`

			```bash
doc: mentions the mercurial dep. 2017-07-06 21:10:18 +02:00			`sudo dnf install perl dos2unix mercurial`
doc: documented the missing build dependencies as per #126. 2015-12-04 06:53:00 +01:00			```

doc: added TOC. 2014-02-19 00:35:23 +01:00			`[Back to TOC](#table-of-contents)`

doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00			`Mailing List`
			`============`

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

doc: fixed more links. 2014-02-19 00:38:47 +01:00			`https://groups.google.com/group/openresty-en`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
doc: some formatting fixes. 2013-10-18 01:19:36 +02:00			`The Chinese mailing list is here:`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
doc: fixed more links. 2014-02-19 00:38:47 +01:00			`https://groups.google.com/group/openresty`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
doc: added TOC. 2014-02-19 00:35:23 +01:00			`[Back to TOC](#table-of-contents)`

doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00			`Report Bugs`
			`===========`

			`You're very welcome to report issues on GitHub:`

renamed ngx_openresty to openresty. 2016-01-25 23:33:53 +01:00			`https://github.com/openresty/openresty/issues`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
doc: added TOC. 2014-02-19 00:35:23 +01:00			`[Back to TOC](#table-of-contents)`

doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00			`Copyright & License`
			`===================`

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

doc: updated copyright notice. 2016-12-18 23:45:13 +01:00			`Copyright (c) 2011-2017, Yichun "agentzh" Zhang (章亦春) <agentzh@gmail.com>, OpenResty Inc.`
doc: use markdown for the README file. 2013-10-18 01:18:48 +02:00
			`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.`

doc: added TOC. 2014-02-19 00:35:23 +01:00			`[Back to TOC](#table-of-contents)`