Documentation

This is the documentation of ngx_mruby 3.x, developed on the branch next. It has four kinds of page: a start page that runs ngx_mruby, guides for tasks, the reference, and the concepts behind them.

Documents

• Start: Get started: run nginx with a Ruby handler in Docker, then change the script
• Guides: Install, Route requests to a backend, Deny clients listed in a file, Limit the rate per API key, Change a response body, Allow TCP connections in Ruby, Agent proxy (development version), and the use cases
• Reference: Directives, Ruby classes and methods, Build
• Concepts: Request phases, Filters, Waiting without blocking, Lifetimes
• Releases: Release notes, which start with the behavior changes to read before upgrading, and Migrating from ngx_mruby 2.x to 3.0.0
• Security: Security policy and Trust boundary: what ngx_mruby trusts, what it treats as client input, and what a script is responsible for
• Contributing: Contributing, Testing, Developing ngx_mruby and the state of the work

Branches and releases

• Branch strategy: what master, next and v2.x hold, and what to pin to stay on 2.x
• Promoting v3 to master: the procedure, for maintainers

License

ngx_mruby is under the MIT License.