mod_lua.html.en revision 3fcdca22487eb5f55815e228f54c4cc8520b1f48
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder This file is generated from xml source: DO NOT EDIT
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<script src="/style/scripts/prettify.js" type="text/javascript">
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<link href="/images/favicon.ico" rel="shortcut icon" /></head>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<p class="apache">Apache HTTP Server Version 2.5</p>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<img alt="" src="/images/feather.gif" /></div>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
ed0055e8e720ca2d07e857e7852de91d47fab9e7Christian Maeder<div id="preamble"><h1>Apache Module mod_lua</h1>
ed0055e8e720ca2d07e857e7852de91d47fab9e7Christian Maeder<p><span>Available Languages: </span><a href="/en/mod/mod_lua.html" title="English"> en </a> |
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<a href="/fr/mod/mod_lua.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p>
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides Lua hooks into various portions of the httpd
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maeder<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>lua_module</td></tr>
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_lua.c</td></tr>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>2.3 and later</td></tr></table>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<p>This module allows the server to be extended with scripts written in the
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian MaederLua programming language. The extension points (hooks) available with
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<code class="module"><a href="/mod/mod_lua.html">mod_lua</a></code> include many of the hooks available to
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maedernatively compiled Apache HTTP Server modules, such as mapping requests to
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederfiles, generating dynamic responses, access control, authentication, and
9d3c461220f8076ef80ca48f7b0574ded9b23e7aChristian Maederauthorization</p>
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<p>More information on the Lua programming language can be found at the
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<a href="http://www.lua.org/">the Lua website</a>.</p>
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maeder<div class="note"><code>mod_lua</code> is still in experimental state.
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian MaederUntil it is declared stable, usage and behavior may change
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederat any time, even between stable releases of the 2.4.x series.
ed0055e8e720ca2d07e857e7852de91d47fab9e7Christian MaederBe sure to check the CHANGES file before upgrading.</div>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<div id="quickview"><h3 class="directives">Directives</h3>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luaauthzprovider">LuaAuthzProvider</a></li>
ce59e0cc5c7221245ed323290bfccbda4ee32dd9Christian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luahookaccesschecker">LuaHookAccessChecker</a></li>
ce59e0cc5c7221245ed323290bfccbda4ee32dd9Christian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luahookauthchecker">LuaHookAuthChecker</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luahookcheckuserid">LuaHookCheckUserID</a></li>
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luahookfixups">LuaHookFixups</a></li>
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luahookinsertfilter">LuaHookInsertFilter</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luahookmaptostorage">LuaHookMapToStorage</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luahooktranslatename">LuaHookTranslateName</a></li>
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luahooktypechecker">LuaHookTypeChecker</a></li>
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luainherit">LuaInherit</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luamaphandler">LuaMapHandler</a></li>
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luapackagecpath">LuaPackageCPath</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luapackagepath">LuaPackagePath</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luaquickhandler">LuaQuickHandler</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luaroot">LuaRoot</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#luascope">LuaScope</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#basicconf">Basic Configuration</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#writinghandlers">Writing Handlers</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#writingauthzproviders">Writing Authorization Providers</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#writinghooks">Writing Hooks</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#datastructures">Data Structures</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#logging">Logging Functions</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<li><img alt="" src="/images/down.gif" /> <a href="#apache2">apache2 Package</a></li>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<h2><a name="basicconf" id="basicconf">Basic Configuration</a></h2>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<p>The basic module loading directive is</p>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<code>mod_lua</code> provides a handler named <code>lua-script</code>,
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maederwhich can be used with an <code>AddHandler</code> directive:</p>
ed0055e8e720ca2d07e857e7852de91d47fab9e7Christian MaederAddHandler lua-script .lua
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian MaederThis will cause <code>mod_lua</code> to handle requests for files
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederending in <code>.lua</code> by invoking that file's
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<p>For more flexibility, see <code class="directive">LuaMapHandler</code>.
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
1da2d3de72cd19f22820492bc832c9964762a64eChristian Maeder<h2><a name="writinghandlers" id="writinghandlers">Writing Handlers</a></h2>
1da2d3de72cd19f22820492bc832c9964762a64eChristian Maeder<p> In the Apache HTTP Server API, the handler is a specific kind of hook
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maederresponsible for generating the response. Examples of modules that include a
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederhandler are <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>, <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>,
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederand <code class="module"><a href="/mod/mod_status.html">mod_status</a></code>.</p>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<p><code>mod_lua</code> always looks to invoke a Lua function for the handler, rather than
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederjust evaluating a script body CGI style. A handler function looks
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maedersomething like this:</p>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder-- example handler
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederrequire "string"
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder This is the default method name for Lua handlers, see the optional
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maeder function-name in the LuaMapHandler directive to choose a different
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederfunction handle(r)
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder r:puts("Hello Lua World!\n")
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder if r.method == 'GET' then
1da2d3de72cd19f22820492bc832c9964762a64eChristian Maeder for k, v in pairs( r:parseargs() ) do
1da2d3de72cd19f22820492bc832c9964762a64eChristian Maeder r:puts( string.format("%s: %s\n", k, v) )
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder elseif r.method == 'POST' then
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder for k, v in pairs( r:parsebody() ) do
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder r:puts( string.format("%s: %s\n", k, v) )
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder r:puts("Unsupported HTTP method " .. r.method)
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian MaederThis handler function just prints out the uri or form encoded
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederarguments to a plaintext page.
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian MaederThis means (and in fact encourages) that you can have multiple
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederhandlers (or hooks, or filters) in the same script.
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
31c6978fd9066c9d2c3c98c950f7abbe89112522Christian Maeder<h2><a name="writingauthzproviders" id="writingauthzproviders">Writing Authorization Providers</a></h2>
31c6978fd9066c9d2c3c98c950f7abbe89112522Christian Maeder<p><code class="module"><a href="/mod/mod_authz_core.html">mod_authz_core</a></code> provides a high-level interface to
1da2d3de72cd19f22820492bc832c9964762a64eChristian Maederauthorization that is much easier to use than using into the relevant
1da2d3de72cd19f22820492bc832c9964762a64eChristian Maederhooks directly. The first argument to the
1da2d3de72cd19f22820492bc832c9964762a64eChristian Maeder<code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> directive gives
1da2d3de72cd19f22820492bc832c9964762a64eChristian Maederthe name of the responsible authorization provider. For any
1da2d3de72cd19f22820492bc832c9964762a64eChristian Maeder<code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> line,
31c6978fd9066c9d2c3c98c950f7abbe89112522Christian Maeder<code class="module"><a href="/mod/mod_authz_core.html">mod_authz_core</a></code> will call the authorization provider
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maederof the given name, passing the rest of the line as parameters. The
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maederprovider will then check authorization and pass the result as return
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder<p>The authz provider is normally called before authentication. If it needs to
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maederknow the authenticated user name (or if the user will be authenticated at
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maederall), the provider must return <code>apache2.AUTHZ_DENIED_NO_USER</code>.
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian MaederThis will cause authentication to proceed and the authz provider to be
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maedercalled a second time.</p>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<p>The following authz provider function takes two arguments, one ip
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maederaddress and one user name. It will allow access from the given ip address
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederwithout authentication, or if the authenticated user matches the second
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederrequire 'apache2'
ed0055e8e720ca2d07e857e7852de91d47fab9e7Christian Maederfunction authz_check_foo(r, ip, user)
ed0055e8e720ca2d07e857e7852de91d47fab9e7Christian Maeder elseif r.user == nil then
ed0055e8e720ca2d07e857e7852de91d47fab9e7Christian Maeder elseif r.user == user then
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<p>The following configuration registers this function as provider
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<code>foo</code> and configures it for URL <code>/</code>:</p>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian MaederLuaAuthzProvider foo authz_provider.lua authz_check_foo
31c6978fd9066c9d2c3c98c950f7abbe89112522Christian Maeder<Location />
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder Require foo 10.1.2.3 john_doe
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder</Location>
ce59e0cc5c7221245ed323290bfccbda4ee32dd9Christian Maeder</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
ce59e0cc5c7221245ed323290bfccbda4ee32dd9Christian Maeder<h2><a name="writinghooks" id="writinghooks">Writing Hooks</a></h2>
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder<p>Hook functions are how modules (and Lua scripts) participate in the
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maederprocessing of requests. Each type of hook exposed by the server exists for
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maedera specific purposes such as mapping requests to the filesystem,
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederperforming access control, or setting mimetypes. General purpose hooks
ed0055e8e720ca2d07e857e7852de91d47fab9e7Christian Maederthat simply run at handy times in the request lifecycle exist as well.</p>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder<p>Hook functions are passed the request object as their only argument.
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian MaederThey can return any value, depending on the hook, but most commonly
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maederthey'll return OK, DONE, or DECLINED, which you can write in lua as
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder<code>apache2.OK</code>, <code>apache2.DONE</code>, or
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder<code>apache2.DECLINED</code>, or else an HTTP status code.</p>
bd8ff5b5f66be563e5be9d3a0c069e32d06f331cChristian Maeder-- example hook that rewrites the URI to a filesystem path.
162a689da386fc8ddbbe47bcae83eaca4fc8dbc0Christian Maederrequire 'apache2'
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maederfunction translate_name(r)
af1cb109bce240bcafe3823df022d6088cbfc438Christian Maeder if r.uri == "/translate-name" then
ed0055e8e720ca2d07e857e7852de91d47fab9e7Christian Maeder r.filename = r.document_root .. "/find_me.txt"
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder -- we don't care about this URL, give another module a chance
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder--[[ example hook that rewrites one URI to another URI. It returns a
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder apache2.DECLINED to give other URL mappers a chance to work on the
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder substitution, including the core translate_name hook which maps based
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder on the DocumentRoot.
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder Note: It is currently undefined as to whether this runs before or after
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maederrequire 'apache2'
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maederfunction translate_name(r)
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder if r.uri == "/translate-name" then
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder<h2><a name="datastructures" id="datastructures">Data Structures</a></h2>
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder <p>The request_rec is mapped in as a userdata. It has a metatable
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder which lets you do useful things with it. For the most part it
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder has the same fields as the request_rec struct (see httpd.h
3db8b71dd1ccc662325b96a5ee8f351ace0293baChristian Maeder until we get better docs here) many of which are writeable as
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder well as readable. (The table fields' content can be changed, but the
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder fields themselves cannot be set to different tables.)</p>
798a3d6fdcb8c17b0bc3502a150be75c9ec8799bChristian Maeder <td><code>context_document_root</code></td>
<dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
<dd>internal constants used by <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></dd>
<div class="directive-section"><h2><a name="LuaAuthzProvider" id="LuaAuthzProvider">LuaAuthzProvider</a> <a name="luaauthzprovider" id="luaauthzprovider">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Plug an authorization provider function into <code class="module"><a href="/mod/mod_authz_core.html">mod_authz_core</a></code>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.5.0 and later</td></tr>
with the <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> directive:</p>
LuaAuthzProvider foo authz.lua authz_check_foo
<div class="directive-section"><h2><a name="LuaHookAccessChecker" id="LuaHookAccessChecker">LuaHookAccessChecker</a> <a name="luahookaccesschecker" id="luahookaccesschecker">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the access_checker phase of request processing</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookAccessChecker /path/to/lua/script.lua hook_function_name [early|late]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
<div class="directive-section"><h2><a name="LuaHookAuthChecker" id="LuaHookAuthChecker">LuaHookAuthChecker</a> <a name="luahookauthchecker" id="luahookauthchecker">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the auth_checker phase of request processing</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookAuthChecker /path/to/lua/script.lua hook_function_name [early|late]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
auth = r.headers_in['Authorization']
r.user = 'foo'
if r.user == nil then
r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
elseif r.user == "foo" then
r:debug("authcheck: user='" .. r.user .. "'")
r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
return apache2.OK
<div class="directive-section"><h2><a name="LuaHookCheckUserID" id="LuaHookCheckUserID">LuaHookCheckUserID</a> <a name="luahookcheckuserid" id="luahookcheckuserid">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the check_user_id phase of request processing</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookCheckUserID /path/to/lua/script.lua hook_function_name [early|late]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
<div class="directive-section"><h2><a name="LuaHookFixups" id="LuaHookFixups">LuaHookFixups</a> <a name="luahookfixups" id="luahookfixups">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the fixups phase of request
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookFixups /path/to/lua/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<div class="directive-section"><h2><a name="LuaHookInsertFilter" id="LuaHookInsertFilter">LuaHookInsertFilter</a> <a name="luahookinsertfilter" id="luahookinsertfilter">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the insert_filter phase of request processing</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookInsertFilter /path/to/lua/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<div class="directive-section"><h2><a name="LuaHookMapToStorage" id="LuaHookMapToStorage">LuaHookMapToStorage</a> <a name="luahookmaptostorage" id="luahookmaptostorage">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the map_to_storage phase of request processing</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookMapToStorage /path/to/lua/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<div class="directive-section"><h2><a name="LuaHookTranslateName" id="LuaHookTranslateName">LuaHookTranslateName</a> <a name="luahooktranslatename" id="luahooktranslatename">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the translate name phase of request processing</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
until one of them returns apache2.OK. If your hook doesn't
apache2.DECLINED. If the request should stop processing, then
if r.uri == "/" then
return apache2.OK
return apache2.DECLINED
<div class="note"><h3>Context</h3><p>This directive is not valid in <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code>, <code class="directive"><a href="/mod/core.html#files"><Files></a></code>, or htaccess
<div class="directive-section"><h2><a name="LuaHookTypeChecker" id="LuaHookTypeChecker">LuaHookTypeChecker</a> <a name="luahooktypechecker" id="luahooktypechecker">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the type_checker phase of request processing</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookTypeChecker /path/to/lua/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<div class="directive-section"><h2><a name="LuaInherit" id="LuaInherit">LuaInherit</a> <a name="luainherit" id="luainherit">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls how parent configuration sections are merged into children</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaInherit none|parent-first|parent-last</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LuaInherit parent-first</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.4.0 and later</td></tr>
<div class="directive-section"><h2><a name="LuaMapHandler" id="LuaMapHandler">LuaMapHandler</a> <a name="luamaphandler" id="luamaphandler">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Map a path to a lua handler</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
<div class="directive-section"><h2><a name="LuaPackageCPath" id="LuaPackageCPath">LuaPackageCPath</a> <a name="luapackagecpath" id="luapackagecpath">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add a directory to lua's package.cpath</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaPackageCPath /path/to/include/?.soa</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
conventions as lua. This just munges the package.cpath in the
<div class="directive-section"><h2><a name="LuaPackagePath" id="LuaPackagePath">LuaPackagePath</a> <a name="luapackagepath" id="luapackagepath">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add a directory to lua's package.path</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaPackagePath /path/to/include/?.lua</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
conventions as lua. This just munges the package.path in the
<div class="directive-section"><h2><a name="LuaQuickHandler" id="LuaQuickHandler">LuaQuickHandler</a> <a name="luaquickhandler" id="luaquickhandler">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the quick handler of request processing</td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<div class="note"><h3>Context</h3><p>This directive is not valid in <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code>, <code class="directive"><a href="/mod/core.html#files"><Files></a></code>, or htaccess
<div class="directive-section"><h2><a name="LuaRoot" id="LuaRoot">LuaRoot</a> <a name="luaroot" id="luaroot">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specify the base path for resolving relative paths for mod_lua directives</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaRoot /path/to/a/directory</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<div class="directive-section"><h2><a name="LuaScope" id="LuaScope">LuaScope</a> <a name="luascope" id="luascope">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>One of once, request, conn -- default is once</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaScope once|request|conn|thread [max|min max]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LuaScope once</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<p><span>Available Languages: </span><a href="/en/mod/mod_lua.html" title="English"> en </a> |
<a href="/fr/mod/mod_lua.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p>
</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_lua.html';
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
<p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--