matsumotory /ngx_mruby

ngx_mruby - A Fast and Memory-Efficient Web Server Extension Mechanism Using Scripting Language mruby for nginx

★ 998⑂ 115👁 39⑃ 710● 118▤ 79
CMITCreated 2012-05-07ngx.mruby.org/
Download: v2.7.9v2.7.9 ↓2.7.92026-11-15
+0
Daily
998
stars
115
forks
39
watchers
710
prs
118
issues
79
releases

README

ngx_mruby: A Fast and Memory-Efficient Nginx Extension Mechanism Scripting with mruby.



  
  
  
  


 Documents
- Install
- Test
- Directives
- Class and Method
- Use Case
- Release notes (behaviour changes to read before upgrading)
- Trust boundary: the configuration and its Ruby code are trusted, what a client sends is not, and what each side is responsible for
- Examples

 Branch strategy

ngx_mruby has three long-lived code branches: master, next and v2.x. Their names and roles stay as they are. master is the 2.x line until v3 is promoted to it, so that everyone who builds from the default branch keeps receiving the 2.x security fixes. v3 is developed on next and becomes master at v3.0.0 (the promotion). From then on, v2.x carries 2.x. The site, ngx.mruby.org, is built from docs/ by .github/workflows/site.yml on next and deployed by GitHub Actions: 3.x from next at the unprefixed paths, 2.x from master under /v2/. The gh-pages branch keeps the old site as history.

text
              until the promotion                 |  after the promotion
                                                  |
next    ---alpha.1---beta.1---rc.1---rc.N---+ |  - - ?
                                                 \
master  -v2.7.0--v2.7.x-- ... -----------o------M--------------- ... -- 3.x
         :        :                        :
v2.x    -v2.7.0--v2.7.x-- ... -----------o---------------------- ... --] 2.x

  a release tag (v2., v3.) or a pre-release tag (v3.0.0-); v2.7.x stands
   for the 2.x releases after v2.7.0
o  the last 2.x commit on master
:  the same commit on both branches
M  the merge of next into master, tagged v3.0.0
?  what next becomes after the promotion is open (see the table below)
]  the end of 2.x support, twelve months after v3.0.0
The merges of master into next before the promotion are not drawn.


| Branch | Until the promotion | After the promotion (v3.0.0) |
|---|---|---|
| master (default branch) | The 2.x line: 2.x fixes, v2. releases | The 3.x line: v3. releases |
| v2.x | The same commits as master: a workflow copies every push to master to v2.x | The 2.x line: stability and security fixes, v2. releases |
| next | Development of v3 and its pre-releases | Open; the recommendation is to keep it for the development of 3.1 (see Promoting v3 to master) |

Until the promotion, master is merged into next after 2.x fixes, so v3 has them too.

v3 is developed on next. Its pre-releases are tagged v3.0.0-alpha.N, v3.0.0-beta.N and v3.0.0-rc.N and are marked as pre-releases on GitHub. Section 6 of the v3 plan (docs/proposals/v3-plan.md on next) sets when the first pre-release of each kind is tagged:

- v3.0.0-alpha.1: when the 2.x test suite passes on the new core of v3 and the sanitizers report nothing.
- v3.0.0-beta.1: when the migration guide and the examples exist.
- v3.0.0-rc.1: when the site and the examples are complete.

v3.0.0 is tagged when next is promoted to master, under the conditions in Promoting v3 to master. No date is se

Latest release

v2.7.9 v2.7.9 2026-11-15
Behavior changes: read before upgrading

 The upstream methods raise ArgumentError on an object whose initialize raised and on a copy made with dup or clone, instead of returning nil or ending the worker (816, 819)

- Before: Nginx::Upstreaminitialize and Nginx::Stream::Connectioninitialize gave the object its upstream before they checked that an upstream had the name, and the upstream methods read it without a check. A script could keep such an object after initialize raised: an object from allocate whose initialize raised, an object on which the script called initialize again (with send) and

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON