Apache HTTP Server Version 2.3
Apache HTTP Server Version 2.3
Available Languages: en
| Description: | Provides Lua hooks to do cool stuff |
|---|---|
| Status: | Experimental |
| Module Identifier: | lua_module |
| Source File: | mod_lua.c |
| Compatibility: | 2.4 and later |
Someone needs to write this.
# Examples are always helpful.
LuaCodeCache LuaHookAccessChecker LuaHookAuthChecker LuaHookAuthChecker LuaHookCheckUserID LuaHookInsertFilter LuaHookMapToStorage LuaHookTranslateName LuaHookTypeChecker LuaMapHandler LuaPackageCPath LuaPackagePath LuaRoot LuaScope
More detailed information about the module in general (as opposed to the individual directives) can follow in sections containing titles.
The id attribute will be translated into a hypertext
anchor target.
References to directives should use the directive tag: TemplateDirective. References to
modules should use the module tag
mod_lua.xml.
| Description: | |
|---|---|
| Syntax: | LuaHookFixups /path/to/lua/script.lua hook_function_name |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
| Description: | |
|---|---|
| Syntax: | LuaCodeCache stat|forever|never |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
Specify the behavior of the in-memory code cache. The default is stat, which stats the top level script (not any included ones) each time that file is needed, and reloads it if the modified time indicates it is newer than the one it has already loaded. The other values cause it to keep the file cached forever (don't stat and replace) or to never cache the file.
In general stat or forever is good production and stat or never for deveopment.
LuaCodeCache stat
LuaCodeCache forever
LuaCodeCache never
| Description: | |
|---|---|
| Syntax: | LuaHookAccessChecker /path/to/lua/script.lua hook_function_name |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
...
| Description: | |
|---|---|
| Syntax: | LuaHookAuthChecker /path/to/lua/script.lua hook_function_name |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
...
| Description: | |
|---|---|
| Syntax: | LuaHookAuthChecker /path/to/lua/script.lua hook_function_name |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
...
| Description: | |
|---|---|
| Syntax: | LuaHookCheckUserID /path/to/lua/script.lua hook_function_name |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
...
| Description: | |
|---|---|
| Syntax: | LuaHookInsertFilter /path/to/lua/script.lua hook_function_name |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
Not Yet Implemented
| Description: | |
|---|---|
| Syntax: | LuaHookMapToStorage /path/to/lua/script.lua hook_function_name |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
...
| Description: | |
|---|---|
| Syntax: | LuaHookTranslateName /path/to/lua/script.lua hook_function_name |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of request processing. The hook function receives a single argument, the request_rec, and should return a status code, which is either an HTTP error code, or the constants defined in the apache2 module: apache2.OK, apache2.DECLINED, or apache2.DONE.
For those new to hooks, basically each hook will be invoked until one of them returns apache2.OK. If your hook doesn't want to do the translation it should just return apache2.DECLINED. If the request should stop processing, then return apache2.DONE.
Example:
LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
-- /scripts/conf/hooks.lua --
function silly_mapper(r)
if r.uri == "/" then
r.file = "/var/www/home.lua"
return apache2.OK
else
return apache2.DECLINED
end
end
| Description: | |
|---|---|
| Syntax: | LuaHookTypeChecker /path/to/lua/script.lua hook_function_name |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
...
| Description: | |
|---|---|
| Syntax: | LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name] |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
This directive matches a uri pattern to invoke a specific handler function in a specific file. It uses PCRE regular expressions to match the uri, and supports interpolating match groups into both the file path and the function name be careful writing your regular expressions to avoid security issues.
LuaMapHandler /(\w+)/(/w+) /scripts/$1.lua handle_$2
This would match uri's such as /photos/show?id=9 to the file /scripts/photos.lua and invoke the handler function handle_show on the lua vm after loading that file.
LuaMapHandler /bingo /scripts/wombat.lua
This would invoke the "handle" function, which is the default if no specific function name is provided.
| Description: | |
|---|---|
| Syntax: | LuaPackageCPath /path/to/include/?.soa |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
Add a path to lua's shared library search path. Follows the same conventions as lua. This just munges the package.cpath in the lua vms.
| Description: | |
|---|---|
| Syntax: | LuaPackagePath /path/to/include/?.lua |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
Add a path to lua's module search path. Follows the same conventions as lua. This just munges the package.path in the lua vms.
LuaPackagePath /scripts/lib/?.lua
LuaPackagePath /scripts/lib/?/init.lua
| Description: | Specify the base path |
|---|---|
| Syntax: | LuaRoot /path/to/a/directory |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
Specify the base path which will be used to evaluate all relative paths within mod_wombat. If not specified they will be resolved relative to the current working directory, which may not always work well for a server.
| Description: | |
|---|---|
| Syntax: | LuaScope once|request|conn|server [max|min max] |
| Context: | |
| Status: | Experimental |
| Module: | mod_lua |
Specify the lifecycle scope of the Lua interpreter which will be used by handlers in this "Directory." The default is "once"
Available Languages: en