OpenResty vs nginx: one resolver directive changed, and a tarball you mirror by hand
High Performance Web Platform Based on Nginx and LuaJIT
At a glance
- What is it?
- OpenResty is nginx plus a matched set of third-party modules, delivered as a tarball you fetch or rebuild rather than a package you install. The one addition to the nginx core that the README documents is resolv.conf parsing in the resolver directive, and that addition is the sharpest thing to understand before adopting it.
- Who is it for?
- Adopt OpenResty if you want nginx with Lua-facing modules already known to work together and you deploy on Linux or Unix. Do not adopt it as a source of portable configuration, because the resolver parsing that distinguishes the bundle from stock nginx does not exist on Windows, and its test target expects a test-nginx checkout beside the repository rather than inside it.
- Can I use it commercially?
- Check first. The repository uses a licence we do not classify automatically, so read its LICENSE file before any commercial use.
- Is it still maintained?
- Yes. The repository last received commits 8 days ago.
- What is it written in?
- Mainly C, according to GitHub's language statistics.
Answers come from the project's GitHub data, last synced on November 13, 2026, and from our analysis. They are not legal advice.
Star history
- openresty/openresty14,131 ★ · +88
| Repository | 2026-09-22 | 2026-11-13 |
|---|---|---|
| openresty/openresty | 14k | 14.1k |
88 Stars in the last 52 days, measured from the daily GitHub snapshot. Compare with other projects
Editorial analysis
The clone is a recipe, not the server: one goal fans out through mirror-tarballs
Five goals sit in the repository Makefile, and only one of them is the default. That default is `all`, and `all` runs a single script:
./util/mirror-tarballsThat is the whole build. The script pulls the nginx core and the third-party module sources into a directory named after the output of `./util/ver`, which means the tree you clone on GitHub contains a procedure, not a working server. To reproduce the bundle tarball you run `make` at the top of the source tree, and the host needs three tools that slim container images routinely omit: `perl`, `dos2unix`, and `mercurial`. Package names are given directly for one distribution only:
sudo dnf install perl dos2unix mercurialTwo consequences follow. First, anyone on a distribution other than Fedora 22 is left to map those three tool names onto their own package manager without help. Second, the documented path for users and the path for builders are different jobs. Users are pointed at the download page and the installation page on openresty.org; neither set of steps appears in the repository. So the fastest route to a running server is a prebuilt tarball, and `make` is for reproducing the bundle rather than for installing it.
Stock nginx makes you enumerate resolvers, OpenResty can read the file
One directive is where this bundle genuinely differs, and the difference is an alternative to the way stock nginx works. The stock nginx `resolver` directive takes an explicit list of nameserver addresses, so a configuration that must follow a DHCP lease or a container runtime rewriting DNS has to either hardcode addresses that will go stale or generate them. OpenResty extends the same directive with a `local` parameter that parses nameservers out of a resolv.conf file. Same directive name, same upstream behaviour, one extra source of addresses. The documented syntax is:
resolver address ... [valid=time] [ipv6=on|off] [local=on|off|path]`valid=time` and `ipv6=on|off` belong to the standard directive. `local` is the addition, and the parameter accepts three shapes rather than a boolean: `local=on`, `local=off`, or `local=` followed by a path. The context list is `http, stream, server, location`, which matters more than it first appears, because the same decision about where nameservers come from governs proxied HTTP traffic and the stream module alike. For an operator, the practical effect is that a config copied from a stock nginx host can be extended with one parameter instead of being rewritten around a nameserver inventory that goes out of date on the next lease renewal.
local defaults to off, so an untouched install behaves exactly like stock nginx
The `local` parameter is off by default, and the whole directive has a listed default of `-`. That default is worth internalising before reading any blog post about OpenResty's DNS handling: an installation that never edits its configuration reads nameservers only from the explicit address list, precisely as nginx does. Parsing is opt-in. When you do opt in, `local=on` selects the standard path of `/etc/resolv.conf`. The path form, shown in the README as `local=/tmp/test.conf`, accepts an arbitrary file, which is the form that matters in build sandboxes and container images where the real resolver file lives somewhere other than `/etc`. What you get in exchange is a file read at a path you named. The README does not document behaviour for a missing or unreadable path, and it says nothing about what happens if the file changes while nginx is running, so a rewritten resolver file is an undocumented area for anyone relying on the on-mode to track a runtime that regenerates it.
A zone-scoped IPv6 nameserver is dropped, and an empty set fails the config
Two rules in the same paragraph decide whether a host starts. Nameserver entries that are IPv6 addresses carrying a zone identifier, written in the README as `fe80::1%eth0`, are skipped. A resolver file that contains only zone-scoped nameservers therefore contributes nothing usable, and whether configuration then fails depends on the merged set: the README states that if no usable nameservers remain, including explicitly configured addresses, configuration fails. So an explicitly configured address in the directive still counts as a usable nameserver when the file yields none. Hosts that rely on link-local resolvers, and container images whose `/etc/resolv.conf` is regenerated at start, are the two cases where this bites.
resolv.conf parsing is unavailable on Windows, and no substitute is documented
There is one hard platform boundary: the README states plainly that this feature is not available on Windows platforms. The rest of the resolver syntax, `valid=time` and `ipv6=on|off` included, is unaffected, so what disappears on Windows is specifically the ability to read addresses out of a file. The consequence is a configuration that looks portable and is not. The same server block carrying `local=on` means different things on a Linux node and a Windows node, and nothing in the configuration file records which one the author had in mind. There is no Windows equivalent path option documented either, so the `local=/tmp/test.conf` substitution that gives you a different file on Unix has no stated counterpart. If you run a mixed estate, check what the directive actually loaded on each host instead of assuming the file you shipped describes the behaviour you deployed. Worth noting alongside that: the repository tree carries a FreeBSD directory and nothing for Windows.
make test reaches outside the tree for test-nginx, and demo/Blog/ is never packaged
The test target points at a directory the repository does not contain:
prove -I../test-nginx/lib -r tThe include path is relative to the top of the bundle tree and resolves to a sibling, so the suite expects a test-nginx checkout sitting next to the bundle. A clone on its own has no such neighbour, and no command for obtaining one is given. The two smoke targets also build different things. `try-luajit` changes into the versioned directory and runs `./configure --with-luajit`. `try-lua` runs `./configure` with no LuaJIT flag, then `$(MAKE)`. Both depend on `all`, so mirroring runs either way. A green plain configure therefore tells you the tree builds without the LuaJIT switch and says nothing about the LuaJIT build, which matters for a project whose description names LuaJIT as its base. The clean goal is blunter still:
rm -rf openresty-*That glob takes every top-level entry beginning with `openresty-`, the versioned trees those targets created. Alongside this, the only example content named in the tree is `demo/Blog/`, and no Makefile goal references it. Read it as reference material for what a Lua-facing site looks like, not as something the build installs, and understand that `util/`, `patches/` and `specs/` are maintainer-side inputs to mirroring rather than runtime components of the server.
The license field says NOASSERTION while the README grants 2-clause BSD
There is a mismatch worth settling before this repository enters a compliance review. The repository's license field reads NOASSERTION. The README states that the bundle itself is licensed under the 2-clause BSD license, and separately that the bundled software components are copyrighted by the respective copyright holders. Those two statements do not conflict, but they scope the grant differently and the narrower one is the README's: the 2-clause terms cover the bundle, and each bundled component keeps its own rights. The README carries a copyright line for 2011-2019 to Yichun agentzh Zhang and OpenResty Inc., and names him as the bundle maintainer. That metadata is not a reason to treat the project as abandoned. The last push on master was 2026-10-28, and the tag list shows v1.27.1.2 and v1.27.1.1 both dated 2025-10-08, with v1.25.3.2 back at 2024-07-19. That gap between a moving master and a tag list whose newest entries are from last year is the thing to check against whatever version you have pinned. Support runs through two Google Groups, one English and one Chinese, with bugs going to the GitHub issue tracker.
Editorial conclusion
Adopt OpenResty if you want nginx with Lua-facing modules already known to work together and you deploy on Linux or Unix. Do not adopt it as a source of portable configuration, because the resolver parsing that distinguishes the bundle from stock nginx does not exist on Windows, and its test target expects a test-nginx checkout beside the repository rather than inside it. Before you commit, read the resolver paragraph against the actual contents of your /etc/resolv.conf, then decide whether you are pinning a tag or tracking master: the newest listed tag is v1.27.1.2 from 2025-10-08 while the last push on master was 2026-10-28. Hand your compliance owner the README wording, not the repository's license field, which reads NOASSERTION.
Frequently asked questions
What is OpenResty used for?
It is a full-fledged web application server built by bundling the standard nginx core, lots of third-party nginx modules, and most of their external dependencies. The bundle maintainer states that because most of those modules are developed by the bundle maintainers, the set can be relied on to play well together.
Is OpenResty free to use?
The bundle itself is licensed under the 2-clause BSD license, which permits redistribution in source and binary forms, with or without modification, provided the stated conditions are met. The bundled software components are copyrighted by their respective copyright holders and are covered separately.
how to install openresty
The project points users at the download page on openresty.org for the latest bundle tarball, and at the installation page on the same site for the steps. The README does not reproduce those steps. Building the bundle from the git repository is a separate path that starts with `make` at the top of the source tree.
How do you use OpenResty?
The README documents no command for starting the server; that part of the procedure stays on the installation page at openresty.org. One boundary is worth knowing before a first run: the resolv.conf parsing feature is not available on Windows platforms, so the `local` parameter on the `resolver` directive does not apply there, and no Windows equivalent for the path form is documented.
What is the latest OpenResty release?
The tag list shows v1.27.1.2 and v1.27.1.1 both dated 2025-10-08, with v1.25.3.2 dated 2024-07-19. The last push on the master branch is dated 2026-10-28, which is newer than the newest listed tag.
Where are OpenResty examples?
The only example content named in the repository tree is demo/Blog/. No Makefile goal builds, installs or copies it, so it is reference material rather than part of the distributed tarball.
Official sources
Add this badge to your README
If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.
[](https://hysenlabs.com/projects/openresty-openresty)Star history chart for your README
[](https://hysenlabs.com/projects/openresty-openresty)Was this useful?