openresty/lua-nginx-module
Lua Nginx Module
This project is an NGINX module that embeds the Lua scripting language directly into the server environment. It functions as a request processor and response filter, enabling the execution of scripts to handle HTTP requests, generate dynamic content, and manage server behavior without external application calls.
The module provides a shared memory dictionary and cache manager, allowing data to be stored and retrieved across all active worker processes. This capability supports the collection of high-performance server metrics and the synchronization of information across concurrent processes.
The system covers a broad range of programmable server extensions, including custom HTTP middleware, dynamic request routing, and programmable access control for validating client identity. It also includes tools for intercepting and transforming response bodies and headers, modifying request URIs during the rewrite phase, and executing initialization code during server startup.
Features
- Embedded Scripting Engines - Integrates a Lua scripting engine directly into the NGINX server to handle requests and generate dynamic content.
- Shared Memory Configuration Stores - Provides a shared memory dictionary for synchronizing state and configuration across all active worker processes.
- Request Path Rewriters - Provides the ability to programmatically modify request URIs and implement dynamic redirects during the server rewrite phase.
- Lifecycle Request Handlers - Executes lifecycle-specific request handlers to rewrite URIs and control access during the NGINX request flow.
- Server Extensions - Embeds the Lua scripting language directly into NGINX to process HTTP requests and generate responses.
- Non-Blocking Suspension Points - Implements non-blocking suspension points using coroutines to handle I/O operations without stalling the main server thread.
- Just-In-Time Compilers - Embeds a just-in-time compiler to execute scripts with near-native performance directly within the server process.
- Scriptable Access Controls - Implements programmable access control that validates client identity and request metadata via Lua scripts to permit or block traffic.
- Request Lifecycle Phases - Executes scripts at specific lifecycle points to manage rewrites, access control, and response generation.
- Custom Middleware Implementations - Implements custom middleware to intercept request-response cycles for header transformation and custom server behavior.
- Shared Memory Management - Manages shared memory segments to synchronize state and session data across concurrent worker processes.
- HTTP Request Handling - Processes incoming HTTP requests and generates responses using embedded Lua scripts.
- Request Routing - Enables dynamic request routing and URI modification using Lua scripts to implement complex dispatch logic.
- Response Body Modifiers - Programmatically alters or transforms HTTP response bodies before they are transmitted to the client.
- C Function Bindings - Provides a foreign function interface to map native C functions to Lua methods for direct server internal access.
- Identity-Based Access Control - Provides programmable access control to validate client identity and metadata before traffic reaches the backend.
- Request Context Management - Maintains a per-request memory context to pass data and state across different execution phases.
- Server Metrics - Collects high-performance server metrics and custom request data using shared memory dictionaries.
- Request Logging - Captures custom request details and metrics during the logging phase for system observability.
- HTTP Response Filters - Intercepts and transforms HTTP response bodies and headers using programmable scripts.
- Response Header Modifiers - Provides utilities for dynamically updating HTTP response headers using Lua scripts before the response is sent to the client.
- Embedded Web Frameworks - Allows running Lua scripts within the server for custom request handling and dynamic content generation.
- Server Initialization Hooks - Executes custom setup code and initializes shared memory through hooks that run when the server starts.
- Scripting Language Integration - Embeds the Lua scripting language into Nginx.
- Web Frameworks - Embeds Lua into Nginx to create a full-featured web server.
