mod_lua.xml revision 249cc9b3d83d3c60666269b90ecb9f1390d32165
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<?xml version="1.0"?>
fb51a6b789d85113d0976148685b0063c294220drbowen<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
77a0265761f1bec2aaa0b4116c644f8066e349e3rbowen<!-- $LastChangedRevision$ -->
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<!--
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen Licensed to the Apache Software Foundation (ASF) under one or more
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen contributor license agreements. See the NOTICE file distributed with
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen this work for additional information regarding copyright ownership.
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen The ASF licenses this file to You under the Apache License, Version 2.0
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen (the "License"); you may not use this file except in compliance with
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen the License. You may obtain a copy of the License at
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen http://www.apache.org/licenses/LICENSE-2.0
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen Unless required by applicable law or agreed to in writing, software
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen distributed under the License is distributed on an "AS IS" BASIS,
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen See the License for the specific language governing permissions and
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen limitations under the License.
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen-->
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<modulesynopsis metafile="mod_lua.xml.meta">
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<name>mod_lua</name>
fb51a6b789d85113d0976148685b0063c294220drbowen
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<description>Provides Lua hooks into various portions of the httpd
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenrequest processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<status>experimental</status>
fb51a6b789d85113d0976148685b0063c294220drbowen<sourcefile>mod_lua.c</sourcefile>
fb51a6b789d85113d0976148685b0063c294220drbowen<identifier>lua_module</identifier>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<compatibility>2.3 and later</compatibility>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<summary>
fb51a6b789d85113d0976148685b0063c294220drbowen<p>Someone needs to write this.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen</summary>
fb51a6b789d85113d0976148685b0063c294220drbowen
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<section id="basicconf"><title>Basic Configuration</title>
fb51a6b789d85113d0976148685b0063c294220drbowen
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen<p>The basic module loading directive is</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<example>
2219c51bf0756c2f6f7deb88a13baf30f141c12epoirier LoadModule lua_module modules/mod_lua.so
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen</example>
fb51a6b789d85113d0976148685b0063c294220drbowen
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<p>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<code>mod_lua</code> provides a handler named <code>lua-script</code>,
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenwhich can be used with an <code>AddHandler</code> directive:</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<example>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenAddHandler lua-script .lua
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen</example>
fb51a6b789d85113d0976148685b0063c294220drbowen
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierThis will cause <code>mod_lua</code> to handle requests for files
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierending in <code>.lua</code> by invoking that file's
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<code>handle</code> function.
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</section>
fb51a6b789d85113d0976148685b0063c294220drbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="writinghandlers"><title>Writing Handlers</title>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p><code>mod_lua</code> always looks to invoke a function for the handler, rather than
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenjust evaluating a script body CGI style. A handler function looks
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowensomething like this:</p>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<example><title>example.lua</title><pre>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen require "string"
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen function handle_something(r)
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r.content_type = "text/plain"
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts("Hello Lua World!\n")
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen if r.method == 'GET' then
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen for k, v in pairs( r:parseargs() ) do
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts( string.format("%s: %s", k, v) )
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen end
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen elseif r.method == 'POST' then
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen for k, v in pairs( r:parsebody() ) do
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts( string.format("%s: %s", k, v) )
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen end
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen else
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts("unknown HTTP method " .. r.method)
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen end
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen end
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</pre></example>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis handler function just prints out the uri or form encoded
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenarguments to a plaintext page.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</p>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis means (and in fact encourages) that you can have multiple
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenhandlers (or hooks, or filters) in the same script.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</p>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</section>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="datastructures"><title>Data Structures</title>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<dl>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<dt>request_rec</dt>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <dd>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <p>The request_rec is mapped in as a userdata. It has a metatable
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen which lets you do useful things with it. For the most part it
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen has the same fields as the request_rec struct (see httpd.h
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen until we get better docs here) many of which are writeable as
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier well as readable. (Tables' content can be changed, but the
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier field itself cannot be set to a different table.)</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <table border="1">
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <th><strong>Name</strong></th>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <th><strong>Lua type</strong></th>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <th><strong>Writable</strong></th>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>ap_auth_type</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>args</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>assbackwards</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>boolean</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>canonical_filename</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>content_encoding</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>content_type</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>yes</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>document_root</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>err_headers_out</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>table</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>filename</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>yes</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>headers_in</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>table</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>yes</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>headers_out</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>table</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>yes</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>hostname</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>method</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>notes</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>table</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>path_info</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>protocol</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>range</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>status</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>number</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>yes</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>the_request</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>unparsed_uri</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>uri</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>yes</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>user</code></td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>yes</td>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </table>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <p>The request_rec has (at least) the following methods:</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <example>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:addoutputfilter(name|function) -- add an output filter
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </example>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <example>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:parseargs() -- returns a lua table containing the request's
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier query string arguments
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </example>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <example>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:parsebody() -- parse the request body as a POST and return
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier a lua table
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </example>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <example>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts("hello", " world", "!") -- print to response body
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen </example>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <example>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:write("a single string") -- print to response body
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </example>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen </dd>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen </dl>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</section>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="logging"><title>Logging Functions</title>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<example>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:debug("This is a debug log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:info("This is an info log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:notice("This is an notice log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:warn("This is an warn log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:err("This is an err log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:alert("This is an alert log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:crit("This is an crit log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:emerg("This is an emerg log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</example>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</section>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<section id="apache2"><title>apache2 Module</title>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<p>A module named <code>apache2</code> is available with (at least) the following contents.</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<dl>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dt>apache2.OK</dt>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constant OK. Handlers should return this if they've
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier handled the request.</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dt>apache2.DECLINED</dt>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constant DECLINED. Handlers should return this if
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier they are not going to handle the request.</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dt>apache2.DONE</dt>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constant DONE.</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dt>apache2.version</dt>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>Apache HTTP server version string</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>HTTP status code</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier</dl>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier</section>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaRoot</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Specify the base path for resolving relative paths for mod_lua directives</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaRoot /path/to/a/directory</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<usage>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Specify the base path which will be used to evaluate all
2219c51bf0756c2f6f7deb88a13baf30f141c12epoirier relative paths within mod_lua. If not specified they
fb51a6b789d85113d0976148685b0063c294220drbowen will be resolved relative to the current working directory,
fb51a6b789d85113d0976148685b0063c294220drbowen which may not always work well for a server.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaScope</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>One of once, request, conn, server -- default is once</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaScope once|request|conn|server [max|min max]</syntax>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<default>LuaScope once</default>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<usage>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Specify the lifecycle scope of the Lua interpreter which will
c994f52ac80f9664d2940e5ccd9e77466572013frbowen be used by handlers in this "Directory." The default is "once"</p>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dl>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>once:</dt> <dd>use the interpreter once and throw it away.</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>request:</dt> <dd>use the interpreter to handle anything based on
fb51a6b789d85113d0976148685b0063c294220drbowen the same file within this request, which is also
c994f52ac80f9664d2940e5ccd9e77466572013frbowen request scoped.</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>server:</dt> <dd>This one is different than others because the
fb51a6b789d85113d0976148685b0063c294220drbowen server scope is quite long lived, and multiple threads
fb51a6b789d85113d0976148685b0063c294220drbowen will have the same server_rec. To accommodate this
fb51a6b789d85113d0976148685b0063c294220drbowen server scoped interpreter are stored in an apr
fb51a6b789d85113d0976148685b0063c294220drbowen resource list. The min and max arguments are intended
c994f52ac80f9664d2940e5ccd9e77466572013frbowen to specify the pool size, but are unused at this time.</dd>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen </dl>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen</usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaMapHandler</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Map a path to a lua handler</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen<usage>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This directive matches a uri pattern to invoke a specific
fb51a6b789d85113d0976148685b0063c294220drbowen handler function in a specific file. It uses PCRE regular
fb51a6b789d85113d0976148685b0063c294220drbowen expressions to match the uri, and supports interpolating
fb51a6b789d85113d0976148685b0063c294220drbowen match groups into both the file path and the function name
fb51a6b789d85113d0976148685b0063c294220drbowen be careful writing your regular expressions to avoid security
fb51a6b789d85113d0976148685b0063c294220drbowen issues.</p>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <example><title>Examples:</title>
fb51a6b789d85113d0976148685b0063c294220drbowen LuaMapHandler /(\w+)/(/w+) /scripts/$1.lua handle_$2
c994f52ac80f9664d2940e5ccd9e77466572013frbowen </example>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This would match uri's such as /photos/show?id=9
fb51a6b789d85113d0976148685b0063c294220drbowen to the file /scripts/photos.lua and invoke the
fb51a6b789d85113d0976148685b0063c294220drbowen handler function handle_show on the lua vm after
fb51a6b789d85113d0976148685b0063c294220drbowen loading that file.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<example>
fb51a6b789d85113d0976148685b0063c294220drbowen LuaMapHandler /bingo /scripts/wombat.lua
fb51a6b789d85113d0976148685b0063c294220drbowen</example>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This would invoke the "handle" function, which
fb51a6b789d85113d0976148685b0063c294220drbowen is the default if no specific function name is
fb51a6b789d85113d0976148685b0063c294220drbowen provided.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaPackagePath</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Add a directory to lua's package.path</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaPackagePath /path/to/include/?.lua</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>Add a path to lua's module search path. Follows the same
fb51a6b789d85113d0976148685b0063c294220drbowen conventions as lua. This just munges the package.path in the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen lua vms.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <example><title>Examples:</title>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen LuaPackagePath /scripts/lib/?.lua<br />
fb51a6b789d85113d0976148685b0063c294220drbowen LuaPackagePath /scripts/lib/?/init.lua
c994f52ac80f9664d2940e5ccd9e77466572013frbowen </example>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen</usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaPackageCPath</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Add a directory to lua's package.cpath</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaPackageCPath /path/to/include/?.soa</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<usage>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Add a path to lua's shared library search path. Follows the same
fb51a6b789d85113d0976148685b0063c294220drbowen conventions as lua. This just munges the package.cpath in the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen lua vms.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
c994f52ac80f9664d2940e5ccd9e77466572013frbowen</usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaCodeCache</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Configure the compiled code cache.</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaCodeCache stat|forever|never</syntax>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<default>LuaCodeCache stat</default>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<usage><p>
fb51a6b789d85113d0976148685b0063c294220drbowen Specify the behavior of the in-memory code cache. The default
fb51a6b789d85113d0976148685b0063c294220drbowen is stat, which stats the top level script (not any included
fb51a6b789d85113d0976148685b0063c294220drbowen ones) each time that file is needed, and reloads it if the
fb51a6b789d85113d0976148685b0063c294220drbowen modified time indicates it is newer than the one it has
fb51a6b789d85113d0976148685b0063c294220drbowen already loaded. The other values cause it to keep the file
fb51a6b789d85113d0976148685b0063c294220drbowen cached forever (don't stat and replace) or to never cache the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen file.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <p>In general stat or forever is good production and stat or never
c994f52ac80f9664d2940e5ccd9e77466572013frbowen for deveopment.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <example><title>Examples:</title>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen LuaCodeCache stat<br />
c994f52ac80f9664d2940e5ccd9e77466572013frbowen LuaCodeCache forever<br />
c994f52ac80f9664d2940e5ccd9e77466572013frbowen LuaCodeCache never<br />
c994f52ac80f9664d2940e5ccd9e77466572013frbowen </example>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen
c994f52ac80f9664d2940e5ccd9e77466572013frbowen</usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaHookTranslateName</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the translate name phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookTranslateName /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<usage><p>
fb51a6b789d85113d0976148685b0063c294220drbowen Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
fb51a6b789d85113d0976148685b0063c294220drbowen request processing. The hook function receives a single
fb51a6b789d85113d0976148685b0063c294220drbowen argument, the request_rec, and should return a status code,
fb51a6b789d85113d0976148685b0063c294220drbowen which is either an HTTP error code, or the constants defined
fb51a6b789d85113d0976148685b0063c294220drbowen in the apache2 module: apache2.OK, apache2.DECLINED, or
fb51a6b789d85113d0976148685b0063c294220drbowen apache2.DONE. </p>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen <p>For those new to hooks, basically each hook will be invoked
fb51a6b789d85113d0976148685b0063c294220drbowen until one of them returns apache2.OK. If your hook doesn't
fb51a6b789d85113d0976148685b0063c294220drbowen want to do the translation it should just return
fb51a6b789d85113d0976148685b0063c294220drbowen apache2.DECLINED. If the request should stop processing, then
fb51a6b789d85113d0976148685b0063c294220drbowen return apache2.DONE.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Example:</p>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen <example>
fb51a6b789d85113d0976148685b0063c294220drbowen LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper<br />
fb51a6b789d85113d0976148685b0063c294220drbowen<br />
fb51a6b789d85113d0976148685b0063c294220drbowen -- /scripts/conf/hooks.lua --<br />
fb51a6b789d85113d0976148685b0063c294220drbowen function silly_mapper(r)<br />
fb51a6b789d85113d0976148685b0063c294220drbowen if r.uri == "/" then<br />
fb51a6b789d85113d0976148685b0063c294220drbowen r.file = "/var/www/home.lua"<br />
fb51a6b789d85113d0976148685b0063c294220drbowen return apache2.OK<br />
fb51a6b789d85113d0976148685b0063c294220drbowen else<br />
fb51a6b789d85113d0976148685b0063c294220drbowen return apache2.DECLINED<br />
fb51a6b789d85113d0976148685b0063c294220drbowen end<br />
fb51a6b789d85113d0976148685b0063c294220drbowen end<br />
fb51a6b789d85113d0976148685b0063c294220drbowen</example>
fb51a6b789d85113d0976148685b0063c294220drbowen</usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<name>LuaHookFixups</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the fixups phase of request
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowenprocessing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookFixups /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen<usage>
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen<p>
fb51a6b789d85113d0976148685b0063c294220drbowen Just like LuaHookTranslateName, but executed at the fixups phase
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen</p>
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen</usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaHookMapToStorage</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the map_to_storage phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookMapToStorage /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>...</p></usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaHookCheckUserID</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the check_user_id phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookCheckUserID /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>...</p></usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaHookTypeChecker</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the type_checker phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookTypeChecker /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>...</p></usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaHookAuthChecker</name>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<description>Provide a hook for the auth_checker phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookAuthChecker /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>...</p></usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaHookAccessChecker</name>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<description>Provide a hook for the access_checker phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookAccessChecker /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>...</p></usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<name>LuaHookInsertFilter</name>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<description>Provide a hook for the insert_filter phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookInsertFilter /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>Not Yet Implemented</p></usage>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<name>LuaQuickHandler</name>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the quick handler of request processing</description>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<syntax></syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<override>All</override>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<usage><p>...</p></usage>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen</directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen
fb51a6b789d85113d0976148685b0063c294220drbowen</modulesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen