# openresty-build-tools

**Repository Path**: HalfView/openresty-build-tools

## Basic Information

- **Project Name**: openresty-build-tools
- **Description**: openresty-build-tools
- **Primary Language**: Lua
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-08-25
- **Last Updated**: 2025-07-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# openresty-build-tools

Reusable script for bootstrapping core components needed for Kong development.

This script builds different flavors of OpenSSL, OpenResty and LuaRocks depends on command
line arguments passed to it. It does this independently of what the base O/S library version
is so you always ends up with the same binary, every time.

# Synopsis
```
./kong-ngx-build -p buildroot --openresty 1.13.6.2 --openssl 1.1.1b --luarocks 3.0.4 --pcre 8.43 --debug
```

# Usage
```
$ ./kong-ngx-build -h
Build basic components (OpenResty, OpenSSL and LuaRocks) for Kong.

Usage: ./kong-ngx-build [options...] -p <prefix> --openresty <openresty_ver> --openssl <openssl_ver>

Required arguments:
  -p, --prefix <prefix>              Location where components should be installed.
      --openresty <openresty_ver>    Version of OpenResty to build, such as 1.13.6.2.
      --openssl <openssl_ver>        Version of OpenSSL to build, such as 1.1.1c.

Optional arguments:
      --no-openresty-patches         Do not apply openresty-patches while compiling OpenResty.
                                     (Patching is enabled by default)

      --openresty-patches <branch>   Specify an openresty-patches branch to use when applying patches.
                                     (Defaults to "master")
                                     NOTE: This option is mutually exclusive with --openresty-patches-dir.

      --openresty-patches-dir <dir>  Specify the root directory of a local copy of openresty-patches
                                     to use instead of checking out a branch from the repository.
                                     NOTE: This option is mutually exclusive with --openresty-patches.

      --no-kong-nginx-module         Do not include lua-kong-nginx-module while patching and compiling OpenResty.
                                     (Patching and compiling is enabled by default for OpenResty > 1.13.6.1)

      --kong-nginx-module <branch>   Specify a lua-kong-nginx-module branch to use when patching and compiling.
                                     (Defaults to "master")

      --luarocks <luarocks_ver>      Version of LuaRocks to build, such as 3.1.2. If absent, LuaRocks
                                     will not be built.

      --pcre <pcre_ver>              Version of PCRE to build, such as 8.43. If absent, PCRE will
                                     not be build.

      --add-module <module_path>     Path to additional NGINX module to be built. This option can be
                                     repeated and will be passed to NGINX's configure in the order
                                     they were specified.

      --debug                        Disable compile-time optimizations and memory pooling for NGINX,
                                     LuaJIT and OpenSSL to help debugging.

  -j, --jobs                         Concurrency level to use when building.
                                     (Defaults to number of CPU cores available: 12)

      --work <work>                  The working directory to use while compiling.
                                     (Defaults to "work")

  -f, --force                        Build from scratch.
                                     WARNING: This permanently removes everything inside the <work> and <prefix> directories.

  -h, --help                         Show this message.

Optional environment variables:

The following environment variables are likely only utilized when building for the purposes of packaging Kong

  LUAROCKS_INSTALL                 Overrides the `./config --prefix` value (default is `<prefix>/luarocks`)

  LUAROCKS_DESTDIR                 Overrides the `make install DESTDIR` (default is `/`)

  OPENRESTY_INSTALL                Overrides the `./config --prefix` value (default is `--prefix/openresty)

  OPENRESTY_DESTDIR                Overrides the `make install DESTDIR` (default is `/`)

  OPENSSL_INSTALL                  Overrides the `./config --prefix` value (default is `--prefix/openssl)

  OPENRESTY_RPATH                  Overrides the `make install DESTDIR` (default is `/`)

```

# Caching
This script supports two level of caching: artifact caching and build caching
in order to speed up re-compilation time for various different scenarios.

By default, both artifact caching and build caching are enabled.

Artifact caching checks the installation directory inside `prefix`, if that
directory is found, then it is assumed that software has been built already
and no more work is done on it.

Build caching saves the source code directory of the software to be built.
Repeated run will simply call `make` and `make install` again which supports
incremental rebuild Make provides. This is especially useful when developing
on OpenResty or NGINX C code.

If caching is undesirable or dependency version changed,
you can disable both caching with the `--force` option.

# Special notes for macOS users
`openresty-build-tools` needs a few utilities from the GNU `coreutils` suite to
run properly on a Mac. It can be installed using [Homebrew](https://brew.sh)
easily:

```shell
$ brew install coreutils
```

# License

```
Copyright 2019 Kong Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```