Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
mod_mruby - A Fast and Memory-Efficient Web Server Extension Mechanism Using Scripting Language mruby for Apache httpd
C Ruby JavaScript Shell
Failed to load latest commit information.
docker Update docker example
example Add example
images Add image
lib remove redis
mrbgems/mod_mruby_mrblib Move mod_mruby_mrblib from matsumoto-r/mruby-mod-mruby-ext
mruby @ 2fe556d Update mruby
src Bumpup version to 1.10.9
test `Apache.log` supports apache 2.4
webif Fix merge method error
.gitignore Update gitignore
.gitmodules change to use https:// instead of git://
.travis.yml Update apr for travis
AUTHORS AUTHORS created.
Dockerfile Merge branch 'master' of github.com:matsumoto-r/mod_mruby
LEGAL Update LICENSE information
MITL Update LICENSE information
Makefile.in Support multi build automatically
Makefile.w32 Specify absolute path for apxs.
README.md Added Gitter badge
TODO Add TODO
build.sh Fix bug; related to matsumoto-r/ngx_mruby#116
build_config.rb Refactore build configuration
config.h.in Fix HAVE_UNISTD_H warning and error log priority.
configure
configure.in change to use https:// instead of git://
httpd_version Update apr
test.sh Fix bug; related to matsumoto-r/ngx_mruby#116
wercker.yml Basic wercker.yml

README.md

Welcome to mod_mruby Pages

Gitter Build Status wercker status

ngx_mruby mod_mruby performance

hello world simple benchmark, see details of blog entry.

Documents

What's mod_mruby

mod_murby is A Fast and Memory-Efficient Web Server Extension Mechanism Using Scripting Language mruby for Apache httpd.

  • Unified Ruby Code between Apache(mod_mruby), nginx(ngx_mruby) and other Web server software(plan) for Web server extensions.
  • You can implement Apache modules by Ruby on Apache httpd.
  • You can implement some Web server software extensions by same Ruby code (as possible)
  • mod_mruby is to provide an alternative to mod_lua or ngx_mruby of nginx.
  • Supported Apache Version: 2.2 2.4
  • Supported Apache MPM: worker prefork event
  • Supported OS: Linux FreeBSD Windows and so on.
# Apache httpd.conf
# mrubyTranslateNameMiddle "/path/to/proxy.rb"
#

backends = [
  "http://192.168.0.101:8888/",
  "http://192.168.0.102:8888/",
  "http://192.168.0.103:8888/",
  "http://192.168.0.104:8888/",
]

# write balancing algorithm here.

r = Apache::Request.new()

r.handler  = "proxy-server"
r.proxyreq = Apache::PROXYREQ_REVERSE
r.filename = "proxy:" + backends[rand(backends.length)] + r.uri

Apache::return(Apache::OK)
  • see example
  • Sample of Unified Ruby Code between Apache(mod_mruby) and nginx(ngx_mruby) for Web server extensions
  • You can implement some Web server software extensions by same Ruby code (as possible)
# Unified Ruby Code between Apache(mod_mruby) and nginx(ngx_mruby)
# for Web server extensions.
#
# Apache httpd.conf by mod_mruby
#
# <Location /mruby>
#     mrubyHandlerMiddle "/path/to/unified_hello.rb"
# </Location>
#
# nginx ngxin.conf by ngx_mruby
#
# location /mruby {
#     mruby_content_handler "/path/to/unified_hello.rb";
# }
#

Server = get_server_class

Server::rputs "Hello #{Server::module_name}/#{Server::module_version} world!"
# mod_mruby => "Hello mod_mruby/0.9.3 world!"
# ngx_mruby => "Hello ngx_mruby/0.0.1 world!"

Abstract

As the increase of large-scale and complex Web services, not only a development of Web applications but also an implementation of Web server extensions is required in many cases. The Web server extensions were mainly implemented in C language because of fast and memory-efficient behavior, but extension methods using scripting language are proposed with consideration of maintainability and productivity. However, if the existing methods primarily intended to enhance not the implementation of Web applications but the implementation of internal processing of the Web server, the problem remains in terms of fast, memory-efficiency and safety. Therefore, we propose a fast and memory-efficient Web server extension mechanism using scripting language. We design the architecture that a server process create the region to save the state of the interpreter at the server process startup, and multiple scripts share the region in order to process fast when the script is called as internal processing from a Web server process. The server process free the global variables table, the exception flag and the byte-code which cause the increase of memory usage mainly, in order to reduce the memory usage and extend safely by preventing interference between each scripts because of sharing the region. We implement the mechanism that can extend the internal processing of Apache easily by Ruby scripts using Apache and embeddable scripting language mruby. It's called "mod_mruby".

License

under the MIT License:

Something went wrong with that request. Please try again.