OpenResty — High-Performance Web Platform on Nginx + Lua

What it is

OpenResty extends Nginx with LuaJIT, the ngx_lua module, and dozens of curated Lua libraries covering Redis, MySQL, DNS, JSON, JWT, and more. The result is a web platform that retains Nginx's event-driven performance while allowing request handling logic in high-level Lua code. OpenResty is the foundation of Apache APISIX, Kong, and most major open source API gateways.

OpenResty targets backend engineers and platform teams who need programmable request handling at the edge -- custom routing, authentication, rate limiting, or request transformation -- without deploying a separate application server.

How it saves time or tokens

Without OpenResty, implementing custom logic at the Nginx layer requires writing C modules or deploying a separate application behind Nginx. OpenResty lets you write that logic in Lua directly within the Nginx config, executed at near-C speed by LuaJIT. Non-blocking cosocket APIs for Redis, MySQL, and HTTP mean your Lua handlers never block a worker thread.

The single-binary deployment model means you replace stock Nginx with OpenResty and gain full scripting capabilities with zero additional infrastructure.

How to use

1. Install OpenResty:

# Ubuntu/Debian
wget -qO - https://openresty.org/package/pubkey.gpg | sudo apt-key add -
echo 'deb http://openresty.org/package/ubuntu '$(lsb_release -sc)' main' \
  | sudo tee /etc/apt/sources.list.d/openresty.list
sudo apt update && sudo apt install -y openresty

1. Add a Lua handler to your nginx.conf:

server {
  listen 8080;
  location /hi {
    content_by_lua_block {
      ngx.say('hello from openresty')
    }
  }
}

1. Reload and test:

sudo openresty -s reload
curl localhost:8080/hi
# hello from openresty

Example

A rate-limiting handler using OpenResty's shared dictionary:

http {
  lua_shared_dict rate_limit 10m;

  server {
    listen 8080;

    location /api {
      access_by_lua_block {
        local limit = ngx.shared.rate_limit
        local key = ngx.var.remote_addr
        local count = limit:incr(key, 1, 0, 60)
        if count > 100 then
          ngx.status = 429
          ngx.say('rate limit exceeded')
          return ngx.exit(429)
        end
      }
      proxy_pass http://backend;
    }
  }
}

Related on TokRepo

• DevOps Tools -- Infrastructure and deployment tooling
• AI Gateway Providers -- API gateway and proxy solutions

Common pitfalls

• OpenResty uses its own Nginx build. Do not install stock Nginx and OpenResty on the same machine without resolving the port and binary conflicts.
• Lua code in content_by_lua_block runs in the Nginx worker process. Blocking calls (e.g., os.execute, io.read) will stall the entire worker. Always use OpenResty's non-blocking cosocket APIs instead.
• LuaJIT has a 2GB memory limit on 64-bit systems by default. For applications that need large Lua tables or caches, use shared dictionaries (lua_shared_dict) which are allocated outside LuaJIT's heap.