README-windows.txt

Name
    README-windows - README for the official 32-bit and 64-bit Windows
    builds of OpenResty

Table of Contents
    *   Name

    *   Description

    *   Debugging

    *   Caveats

    *   TODO

    *   "Details About The Building Process"

    *   Author

    *   "Copyright & License"

Description
    The official binary Win32 and Win64 distributions of OpenResty can be
    downloaded from the following web page:

    https://openresty.org/en/download.html

    To start the NGINX server of the nginx server of the Win32 binary
    distribution of OpenResty:

        start nginx

    You can also specify the "-p PATH/" option to override the default
    server prefix, as in

        cd /path/to/my/openresty/app/
        start nginx -p $PWD

    Then you can use the "tasklist" command to check the nginx processes
    running in the background:

        C:\> tasklist /fi "imagename eq nginx.exe"
    
        Image Name                     PID Session Name        Session#    Mem Usage
        ========================= ======== ================ =========== ============
        nginx.exe                     4616 Console                    1      7,412 K
        nginx.exe                     5836 Console                    1      7,800 K

    One of the two processes is the master process while the other is the
    worker.

    If you are using the MSYS2 bash instead of the "cmd.exe" console, then
    you should replace the "/fi" option with "-fi" in the command above
    instead.

    You can quickly shut down the server like this:

        nginx -s stop

    or gracefully shut it down like this:

        nginx -s quit

    You can also forcibly kill the nginx processes via their PIDs with
    "taskkill", as in

        C:\> taskkill /pid 5488 /F

    where the PID (5488 in this example) can be found via the aforementioned
    "tasklist" command.

    Again, you should use the form "-pid" and "-F" for the options if you
    are in an MSYS2 bash session.

    Similarly, you can use the "nginx -s reload" command to reload nginx
    configurations without stopping the server. And you can use "nginx -s
    reopen" to instruct nginx to re-open all the log files.

    You can run the "resty" script like this:

        C:\> resty -e "ngx.say('Hello, OpenResty!')"
        Hello, OpenResty!

    The "resty" command-line utility requires a Perl interpreter installed
    in your system and visible to your PATH environment. Any perl
    distributions should work, including StrawberryPerl, ActivePerl, and
    MSYS2 perl. recommended though).

Debugging
    Debug symbosl are enabled even in release builds. So that when things go
    very wrong, one can still debug things with tools like MSYS2 GDB.

    Inclusion of debug symbols make the binary files (".exe" and ".dll"
    files) much larger, but it generally will not load into memory during
    normal execution on a modern operating system.

Caveats
    The Win32/Win64 port of the NGINX core supports the good old "select" IO
    multiplexing mechanism only. The I/O Completion Ports (IOCP) feature is
    *not* supported (yet). So do not use this build for production
    environments with very high concurrency levels.

    This Win32/Win64 build of OpenResty is mainly for developers who want to
    develop their applications in native Windows environment (though they
    eventually push the finished work onto a Linux or *BSD box, most of the
    time).

TODO
    *   Add support for more than one NGINX worker processes.

    *   Add support for concurrent connections more than 1024.

    *   Switch to the Microsoft Visual Studio compiler toolchain for better
        performance and easier binary package redistribution.

    *   Bundle StrawberryPerl to make command-line utilities like "resty"
        work out of the box (without manually installing a Perl).

    *   Deliver an alternative Win32/Win64 binary package built with best
        debuggin capabilities (like enabling NGINX debugging logs, disabling
        C compiler optimizations, and enabling all the assertions and
        checks).

Details About The Building Process
    Usually you do not need to worry about how the Win32/Win64 binaries were
    built on the maintainers'' side. But if you do, please read on.

    The Win32/Win64 build of OpenResty is currently built via the
    MSYS2/MinGW toolchain, including MinGW gcc 7.2.3, MSYS2 perl 5.24.4,
    MSYS2 bash, MSYS2 make, and etc. Basically, it is currently built via
    the following cmmands:

        PCRE=pcre-8.42
        ZLIB=zlib-1.2.11
        OPENSSL=openssl-1.1.0h
    
        mkdir -p objs/lib || exit 1
        cd objs/lib || exit 1
        ls ../../..
        tar -xf ../../../$OPENSSL.tar.gz || exit 1
        tar -xf ../../../$ZLIB.tar.gz || exit 1
        tar -xf ../../../$PCRE.tar.gz || exit 1
        cd ../..
    
        cd objs/lib/$OPENSSL || exit 1
        patch -p1 < ../../../patches/openssl-1.1.0d-sess_set_get_cb_yield.patch || exit 1
        cd ../../..
    
        ./configure \
            --with-cc=gcc \
            --with-ipv6 \
            --prefix= \
            --with-cc-opt='-DFD_SETSIZE=1024' \
            --sbin-path=nginx.exe \
            --with-pcre-jit \
            --without-http_rds_json_module \
            --without-http_rds_csv_module \
            --without-lua_rds_parser \
            --with-ipv6 \
            --with-stream \
            --with-stream_ssl_module \
            --with-stream_ssl_preread_module \
            --with-http_v2_module \
            --without-mail_pop3_module \
            --without-mail_imap_module \
            --without-mail_smtp_module \
            --with-http_stub_status_module \
            --with-http_realip_module \
            --with-http_addition_module \
            --with-http_auth_request_module \
            --with-http_secure_link_module \
            --with-http_random_index_module \
            --with-http_gzip_static_module \
            --with-http_sub_module \
            --with-http_dav_module \
            --with-http_flv_module \
            --with-http_mp4_module \
            --with-http_gunzip_module \
            --with-select_module \
            --with-luajit-xcflags="-DLUAJIT_NUMMODE=2 -DLUAJIT_ENABLE_LUA52COMPAT" \
            --with-pcre=objs/lib/$PCRE \
            --with-zlib=objs/lib/$ZLIB \
            --with-openssl=objs/lib/$OPENSSL \
            -j9 || exit 1
    
        make -j9
        make install

    where the dependency library source tarballs for OpenSSL, Zlib, and PCRE
    are downloaded from their official sites, respectively.

    We automate these commands in a dedicated shell script named
    build-win32.sh
    <https://github.com/openresty/openresty/blob/master/util/build-win32.sh>
    .

    Furthermore, we automate the packaging process of the resulting binaries
    and supporting files with this package-win32.sh
    <https://github.com/openresty/openresty/blob/master/util/package-win32.s
    h> script.

    Usually you can just download and use the binary distribution of
    OpenResty without installing the build toolchain.

Author
    Yichun "agentzh" Zhang <agentzh@gmail.com>, OpenResty Inc.

Copyright & License
    This module is licensed under the BSD license.

    Copyright (C) 2015-2018, by Yichun "agentzh" Zhang (章亦春)
    <agentzh@gmail.com>, OpenResty Inc.

    All rights reserved.

    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.