OpenResty (NGINX + Lua)

What is OpenResty and why is OpenResty used by so many companies nowadays? Read this post to learn its dynamic and non-blocking feature.

Follow this post to implement Hello World in OpenResty!

This post introduces OpenResty's directory structure and related tools, such as NGINX C Modules, test-nginx, lua-resty projects, and more.

We can use OPM or LuaRocks to manage OpenResty third-party packages. Learn more by reading this article.

Nginx provides the Master-Worker model and request execution phases. By reading this post, you can better grasp the basics of Nginx.

Lua is a lightweight and high-level programming language designed primarily for embedded use in applications. Getting started with Lua from here!

LuaJIT is a Just-In-Time Compiler (JIT) for the Lua programming language, what makes LuaJIT faster than Lua? What's the difference between them?

The lua-resty-core is a new FFI-based API for lua-nginx-module, which provides higher performance. Learn more from this post.

LuaJIT has several not yet implemented (LuaJIT NYI) features, learn them well to write high performance Lua codes.

Table is the only data structuring mechanism in Lua. We can use tables to represent ordinary arrays, symbol tables, sets, records, queues, and other data structures. Learn more from this post.

Here are some unique Lua concepts, e.g., Weak Table, Closure, and upvalue.

Some Q&A about OpenResty, API Gateway, and Lua.

OpenResty is built with NGINX and LuaJIT, getting started from here to learn its basic concepts and how it works.

OpenResty not only provides detailed documentation with API parameters, return value typing, and sample codes but also is tested thoroughly with test cases, which are helpful to help developers use OpenResty.

OpenResty is the enhanced NGINX with dynamic requests and responses, and this article explains the APIs for manipulating Request and Response in OpenResty, such as "ngx.req.set_method", "ngx.req.set_uri_args", "ngx.req.set_header", etc.

shared dict is an important data structure in NGINX and OpenResty.

The cosocket is the basis of various lua-resty-* non-blocking libraries. This article introduces the basic concepts and common APIs of cosocket.

Privileged Process and Timer Tasks are important features that distinguish OpenResty from NGINX and other web servers

This article will introduce you to the use of OpenResty common APIs for time manipulation, regular expressions, and other common issues.

OpenResty is easy to implement Memcached Server using the stream module provided by NGINX, which can handle layer 4 of traffic.

The NGINX + Lua (OpenResty) FAQ answers questions about privileged process permissions, phasing and debugging, the practice of ngx.exit, variables, and race condition.

test::nginx is a DSL used for TDD in OpenResty, and can be used for NGINX, HTTP testing

This article describes how to use test::nginx to send requests and handle responses in a test case.

test::nginx has features such as preprocessor, custom functions, shuffle, reindex

This article describes the features of the performance testing tool `wrk` and how to use it for efficient and accurate performance testing

This article describes how to build a test network environment, test::nginx support for SSL, DSL, and the `ab` tool.

Avoid using blocking I/O operations in OpenResty as they affect performance. Some often misused operations are: executing external commands, handling disk I/O and using lusockets

This article introduces the optimization techniques to be followed in OpenResty: processing requests short, simple, and fast and avoiding intermediate data generation. It also shows the optimization techniques for string

In openresty, table has a significant impact on performance. This article describes how to optimize performance by manually maintaining subscripts, reusing table, and tabelpool.

OpenResty style guide contains general rules about "how to write" OpenResty, Lua, NGINX code

This article describes how to debug in OpenResty using breakpoints and print logs, Binary Search Algorithm and Comment, dynamic debugging, flame graph, etc.

This article introduces you to the usage scenarios, usage, and implementation principles of both `shared dict` and `lru` cache in Openresty.

The systemtap-based wrapped toolsets: systemtap-toolkit and stapxx can be used to solve problems for real-time analysis and diagnosis of NGINX and OpenResty.

We can use active update cache, lua-resty-lock, lua-resty-shcache, and NGINX directives to resolve cache stampedes in NGINX, OpenResty.

This article introduces the implementation principles and usage of two cache encapsulation libraries `lua-resty-memcached-shdict` and `lua-resty-mlcache`

This article explains how to use the leaky bucket and the token bucket algorithms in NGINX and OpenResty to solve bursty traffic.

Let's learn how to use the implementation of `limit-req`, `limit-count`, `limit-conn`, and `limit.traffic` in `lua-resty-limit-traffic` and conduct rate limiting with them.

Openresty enables FaaS, Edge Computing, Dynamic Upstream, and more with the dynamic features provided by LuaJIT

Let's learn the commonly used Lua Resty libraries in OpenResty: `lua-resty-ngxvar`, `lua-rapidjson`, and `lua-resty-worker-events`.

This article explains dynamic loading, blocking operations, NYI, dynamic upstream, and caching of shared dictionaries.

This article introduces the role, core components, and concepts of microservice API gateway.

The technical selection of the API Gateway's four core components: storage, routing, schema, and plugins, are introduced respectively.

Minimum examples of how to run an API gateway via NGINX configuration and initialization, matching routes and plugins, loading plugins, and writing plugins are introduced.

This article describes how OpenResty is used in practice, OpenResty database encapsulation, OpenResty web framework, and other issues.