Stream-Lua-Nginx-Module

Visit Tool

stream-lua-nginx-module embeds the Lua programming language into NGINX TCP/UDP servers, allowing developers to extend NGINX functionality with custom Lua scripts. It is a core component of OpenResty, enabling the creation of custom network applications.

Claim this tool

No Views Yet

At a glance

Pricing

Open Source

Free tier

Yes

API

Yes

Skill level

Technical

About

What is stream-lua-nginx-module?

stream-lua-nginx-module is an open-source tool that integrates the Lua programming language directly into NGINX TCP/UDP servers. This module, a fundamental part of the OpenResty project, empowers developers to significantly extend and customize NGINX's capabilities using Lua scripts. It supports various NGINX stream phases, including preread, content, and log, allowing for dynamic request processing, custom load balancing, and advanced logging. Key features include the ability to define TCP servers, handle SSL/TLS connections, and interact with sockets directly within Lua code. It also ports many directives and API functions from ngx_http_lua, providing a familiar environment for those accustomed to NGINX's HTTP module.

Best used for

Ideal for developers who need to add custom logic to NGINX TCP/UDP servers, implement dynamic request processing, and create specialized network applications. Especially valuable for those building high-performance proxies or custom load balancers with fine-grained control over stream data.

Common actions

extend NGINX functionality

customize TCP/UDP servers

implement custom logic

manage network traffic

"AI Agents"face swappinggithub copilotlow-code/no-codecollaborationworkflowsopen-sourceautomated workflowdeepfake

Capabilities

Key features

Embed Lua into NGINX
Customize NGINX TCP/UDP servers
Dynamic request processing
SSL/TLS connection handling
Lua API for NGINX

Target Audience

developer

Integrations

Not yet documented

Pricing & Plans

Open Source

Free

FAQs

What is the primary difference between stream-lua-nginx-module and ngx_http_lua_module?

The stream-lua-nginx-module is a port of ngx_http_lua_module specifically for NGINX's "stream" subsystem. This means it extends Lua's power to generic TCP/UDP servers, whereas ngx_http_lua_module focuses on the HTTP subsystem. The available Lua APIs and Nginx directives are largely similar, but adapted for stream-level operations.

Can I use stream-lua-nginx-module to handle SSL/TLS connections?

Yes, the module fully supports setting up SSL TCP servers. You can define SSL protocols, ciphers, certificates, and keys within your NGINX stream configuration. Additionally, it provides directives like ssl_client_hello_by_lua_block and ssl_certificate_by_lua_block for advanced Lua-based SSL/TLS handling.

How does the preread_by_lua_block directive work and when should I use it?

The preread_by_lua_block directive executes Lua code during the preread phase for each connection. It allows you to inspect or modify initial client data before it's passed further down the chain. This is useful for tasks like protocol detection, initial authentication, or routing decisions based on early data, without consuming the data for subsequent phases.

Trending

Subcategories trending in Coding & Development

Open Source & Models Code Assistants DevOps & Infrastructure No-Code / Low-Code Testing & QA Prompt Engineering

Trending

Explore

Browse AI tools by category

Content & Design Productivity & Business Coding & Development AI Agents & Automation Research & Education Wellness & Lifestyle Career Development Marketing & Growth Data & Analytics Customer Support & CX Finance E-commerce