| Server IP : 216.107.138.43 / Your IP : 216.73.217.127 Web Server : LiteSpeed System : Linux srv514655384.host.ultaserver.net 5.15.0-124-generic #134-Ubuntu SMP Fri Sep 27 20:20:17 UTC 2024 x86_64 User : ojolc3829 ( 1151) PHP Version : 8.0.30 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : ON Directory : /usr/local/lsws/docs/ |
Upload File : |
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>OpenLiteSpeed Users' Manual - Module Configuration</title>
<meta name="description" content="OpenLiteSpeed Users' Manual - Module Configuration." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<script>
(function () {
var theme = 'light';
var resolved = false;
try {
if (window.localStorage) {
var storedTheme = window.localStorage.getItem('hdoc.theme');
if (storedTheme === 'light' || storedTheme === 'dark') {
theme = storedTheme;
resolved = true;
}
}
} catch (err) {
}
if (!resolved && window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
theme = 'dark';
}
document.documentElement.setAttribute('data-theme', theme);
document.documentElement.style.colorScheme = theme;
}());
</script>
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
<link rel="stylesheet" type="text/css" href="css/hdoc-product-accent.css">
<script src="hdoc-search-index.js" defer></script>
<script src="js/hdoc-search.js" defer></script>
</head>
<body>
<div class="doc-shell">
<header class="doc-topbar">
<a class="doc-brand" href="index.html" aria-label="OpenLiteSpeed Users' Manual">
<img src="img/ols_logo.svg" alt="OpenLiteSpeed logo" />
<strong>OpenLiteSpeed Users' Manual</strong>
</a>
<div class="doc-actions">
<button class="doc-menu-toggle" type="button" aria-label="Open menu" data-menu-toggle aria-expanded="false">
<svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M3 12h18M3 6h18M3 18h18" stroke="currentColor" stroke-width="2" stroke-linecap="round"/></svg>
</button>
<form class="doc-search" role="search" data-empty="Search pages and settings" data-no-results="No results found.">
<label class="sr-only" for="doc-search-input">Search the manual</label>
<div class="doc-search__box">
<input id="doc-search-input" type="search" autocomplete="off" placeholder="Search pages and settings" aria-controls="doc-search-results" />
<button type="submit">Search</button>
</div>
<div id="doc-search-results" class="doc-search__results" hidden></div>
</form>
</div>
<label class="doc-language"><select id="doc-language-switcher" name="doc_language" data-language-switcher aria-label="Language"><option value="Module_Help.html" data-lang="en-US" selected>English</option><option value="es-ES/Module_Help.html" data-lang="es-ES">Español</option><option value="de-DE/Module_Help.html" data-lang="de-DE">Deutsch</option><option value="fr-FR/Module_Help.html" data-lang="fr-FR">Français</option><option value="zh-CN/Module_Help.html" data-lang="zh-CN">简体中文</option><option value="ja-JP/Module_Help.html" data-lang="ja-JP">日本語</option></select></label>
<button class="doc-theme-toggle" type="button" aria-label="Toggle theme" data-theme-toggle data-theme-light-label="Light mode" data-theme-dark-label="Dark mode" title="Toggle theme">
<span class="doc-theme-toggle__icon" aria-hidden="true"></span>
</button>
</header>
<div class="doc-menu-backdrop" data-menu-backdrop></div>
<div class="pagewrapper" data-current-lang="en-US" data-supported-langs="["en-US","es-ES","de-DE","fr-FR","zh-CN","ja-JP"]"><aside class="sidetree"><div class="sidetree__masthead"><figure class="sidetree__figure"><img src="img/ols_logo.svg" alt="OpenLiteSpeed logo" /></figure><div class="sidetree__identity"><a class="sidetree__manual-link" href="index.html">Users' Manual</a><div class="sidetree__version">Version 1.9 — Rev. 3</div></div></div><nav class="sidetree__nav" aria-label="Table of Contents"><ul class="sidetree__list">
<li><a href="license.html">License</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation/Uninstallation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="level2">
<li><a href="ServerStat_Help.html">Service Manager</a></li>
<li><a href="Real_Time_Stats_Help.html">Real-Time Stats</a></li>
</ul>
</li>
<li><a href="security.html">Security</a></li>
<li>
<a href="config.html">Configuration</a>
<ul class="level2">
<li><a href="ServGeneral_Help.html">Server General</a></li>
<li><a href="ServLog_Help.html">Server Log</a></li>
<li><a href="ServTuning_Help.html">Server Tuning</a></li>
<li><a href="ServSecurity_Help.html">Server Security</a></li>
<li>
<a href="ExtApp_Help.html">External Apps</a>
<ul class="level3">
<li><a href="External_LSAPI.html">LSAPI App</a></li>
<li><a href="External_WS.html">Web Server (Proxy)</a></li>
<li><a href="External_FCGI.html">Fast CGI App</a></li>
<li><a href="External_FCGI_Auth.html">Fast CGI Authorizer</a></li>
<li><a href="External_SCGI.html">Simple CGI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_PL.html">Piped Logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
<li><a href="External_UWSGI.html">uWSGI</a></li>
</ul>
</li>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="App_Server_Help.html">App Server Settings</a></li>
<li><a class="current" href="Module_Help.html">Module Configuration</a></li>
<li><a href="Listeners_General_Help.html">Listener General</a></li>
<li><a href="Listeners_SSL_Help.html">Listener SSL</a></li>
<li><a href="Templates_Help.html">Virtual Host Templates</a></li>
<li><a href="VirtualHosts_Help.html">Virtual Host Registration</a></li>
<li><a href="VHGeneral_Help.html">Virtual Host General</a></li>
<li><a href="VHSecurity_Help.html">Virtual Host Security</a></li>
<li><a href="VHSSL_Help.html">Virtual Host SSL</a></li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li>
<a href="Context_Help.html">Context</a>
<ul class="level3">
<li><a href="Static_Context.html">Static Context</a></li>
<li><a href="Java_Web_App_Context.html">Java Web App Context</a></li>
<li><a href="Servlet_Context.html">Servlet Context</a></li>
<li><a href="FCGI_Context.html">Fast CGI Context</a></li>
<li><a href="SCGI_Context.html">Simple CGI Context</a></li>
<li><a href="LSAPI_Context.html">LSAPI Context</a></li>
<li><a href="Proxy_Context.html">Proxy Context</a></li>
<li><a href="CGI_Context.html">CGI Context</a></li>
<li><a href="LB_Context.html">Load Balancer Context</a></li>
<li><a href="Redirect_Context.html">Redirect Context</a></li>
<li><a href="App_Server_Context.html">App Server Context</a></li>
<li><a href="UWSGI_Context.html">uWSGI Context</a></li>
<li><a href="Module_Context.html">Module Handler Context</a></li>
</ul>
</li>
<li><a href="VHWebSocket_Help.html">Web Socket Proxy</a></li>
</ul>
</li>
<li><a href="webconsole.html">Web Console</a>
<ul class="level2">
<li><a href="AdminGeneral_Help.html">Admin Console General</a></li>
<li><a href="AdminSecurity_Help.html">Admin Console Security</a></li>
<li><a href="AdminListeners_General_Help.html">Admin Listener General</a></li>
<li><a href="AdminListeners_SSL_Help.html">Admin Listener SSL</a></li>
</ul>
</li>
</ul></nav></aside><article class="contentwrapper"><div class="nav-bar"><div class="prev">« <a href="App_Server_Help.html">App Server Settings</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="Listeners_General_Help.html">Listeners General</a> »</div></div>
<header class="doc-page-header"><h1>Module Configuration</h1><div class="doc-page-intro">Module support is available in OpenLiteSpeed 1.3 and LSWS Enterprise 5.0 and greater. All required modules must be registered under the Server Modules Configuration tab. Module files must be located in the server root/modules folder to be available for registering. On start up, the server loads all registered modules. The server must be restarted after new modules are registered.<br/><br/> Modules can be configured globally under the Server Module configuration tab. The configuration data is then available to the Listener and Virtual Host Module Configurations to inherit or modify.</div>
</header><section class="doc-toc" aria-labelledby="top"><header class="doc-toc__header"><h2 id="top">Table of Contents</h2></header><section class="doc-toc__row"><h3 class="doc-toc__heading"><a href="#servModules">Server Modules</a></h3><ul class="doc-toc__links"><li><a href="#modulename">Module</a></li><li><a href="#internalmodule">Is Internal</a></li><li><a href="#modParams">Module Parameters</a></li><li><a href="#moduleEnabled">Enable Module</a></li><li><a href="#L4_BEGINSESSION">Hook::L4_BEGINSESSION Priority</a></li><li><a href="#L4_ENDSESSION">Hook::L4_ENDSESSION Priority</a></li><li><a href="#L4_RECVING">Hook::L4_RECVING Priority</a></li><li><a href="#L4_SENDING">Hook::L4_SENDING Priority</a></li><li><a href="#HTTP_BEGIN">Hook::HTTP_BEGIN Priority</a></li><li><a href="#RECV_REQ_HEADER">Hook::RECV_REQ_HEADER Priority</a></li><li><a href="#URI_MAP">Hook::URI_MAP Priority</a></li><li><a href="#HTTP_AUTH">Hook::HTTP_AUTH Priority</a></li><li><a href="#RECV_REQ_BODY">Hook::RECV_REQ_BODY Priority</a></li><li><a href="#RCVD_REQ_BODY">Hook::RCVD_REQ_BODY Priority</a></li><li><a href="#RECV_RESP_HEADER">Hook::RECV_RESP_HEADER Priority</a></li><li><a href="#RECV_RESP_BODY">Hook::RECV_RESP_BODY Priority</a></li><li><a href="#RCVD_RESP_BODY">Hook::RCVD_RESP_BODY Priority</a></li><li><a href="#HANDLER_RESTART">Hook::HANDLER_RESTART Priority</a></li><li><a href="#SEND_RESP_HEADER">Hook::SEND_RESP_HEADER Priority</a></li><li><a href="#SEND_RESP_BODY">Hook::SEND_RESP_BODY Priority</a></li><li><a href="#HTTP_END">Hook::HTTP_END Priority</a></li><li><a href="#MAIN_INITED">Hook::MAIN_INITED Priority</a></li><li><a href="#MAIN_PREFORK">Hook::MAIN_PREFORK Priority</a></li><li><a href="#MAIN_POSTFORK">Hook::MAIN_POSTFORK Priority</a></li><li><a href="#WORKER_POSTFORK">Hook::WORKER_POSTFORK Priority</a></li><li><a href="#WORKER_ATEXIT">Hook::WORKER_ATEXIT Priority</a></li><li><a href="#MAIN_ATEXIT">Hook::MAIN_ATEXIT Priority</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading"><a href="#listenerModules">Listener Modules</a></h3><ul class="doc-toc__links"><li><a href="#modulename">Module</a></li><li><a href="#modParams">Module Parameters</a></li><li><a href="#moduleEnabled_lst">Enable Module</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading"><a href="#vhModules">Virtual Host Modules</a></h3><ul class="doc-toc__links"><li><a href="#modulename">Module</a></li><li><a href="#modParams">Module Parameters</a></li><li><a href="#moduleEnabled_vh">Enable Module</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading"><a href="#vhModuleUrlFilters">Virtual Host Module Context</a></h3><ul class="doc-toc__links"><li><a href="#expuri">URI</a></li><li><a href="#modParams">Module Parameters</a></li></ul></section>
</section>
<section class="doc-content-flow"><div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="servModules"><h3>Server Modules<span class="ls-permlink"><a href="#servModules"></a></span></h3></header><h4>Description</h4><p>The Server module configuration globally defines the module configuration data. Once defined, the Listeners and Virtual Hosts have access to the modules and module configurations.<br/><br/> All modules that are to be processed must be registered in the Server configuration. The Server configuration also defines the default values for module parameter data. These values can be inherited or overridden by the Listener and Virtual Host configuration data.<br/><br/> Module priority is only defined at server level and is inherited by the Listener and Virtual Host configurations.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="modulename"><h3>Module<span class="ls-permlink"><a href="#modulename"></a></span></h3></header><h4>Description</h4><p>The name of an external or internal module to be loaded at server startup.<br/><br/> <b>External</b><br/> The value used for external modules must match the name of the module's ".so" file under $SERVER_ROOT/modules/modulename.so in order to be loaded by the server application. This requires that the server is restarted after a new module is registered.<br/><br/> <b>Internal</b><br/> The value used for internal modules must match the module name used when the module was built. For example, this must be set to "cache" for the internal cache module included with the server.</p> <h4>Syntax</h4><p>string</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="internalmodule"><h3>Is Internal<span class="ls-permlink"><a href="#internalmodule"></a></span></h3></header><h4>Description</h4><p>Specify whether the module is an internal module, which is statically linked, instead of being an external .so library.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="modParams"><h3>Module Parameters<span class="ls-permlink"><a href="#modParams"></a></span></h3></header><h4>Description</h4><p>Set module parameters. The module parameters are defined by the module developer.<br/><br/> The value set at the Server-level will globally be assigned as the default value. The user can override this setting at the Listener, Virtual Host, or Context levels. If unset at any of those levels, the value will be inherited from the next level up.</p> <h4>Syntax</h4><p>Specified by the module interface.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="moduleEnabled"><h3>Enable Module<span class="ls-permlink"><a href="#moduleEnabled"></a></span></h3></header><h4>Description</h4><p>Enables module hooks globally. This setting can be overridden at the Listener and Virtual Host levels.<br/><br/> Default value: <span class="val">Yes</span></p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="L4_BEGINSESSION"><h3>Hook::L4_BEGINSESSION Priority<span class="ls-permlink"><a href="#L4_BEGINSESSION"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the L4 Begin Session Hook.<br/><br/> The L4 Begin Session Hook is triggered when the TCP/IP connection begins.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="L4_ENDSESSION"><h3>Hook::L4_ENDSESSION Priority<span class="ls-permlink"><a href="#L4_ENDSESSION"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the L4 End Session Hook.<br/><br/> The L4 End Session Hook is triggered when the TCP/IP connection ends.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="L4_RECVING"><h3>Hook::L4_RECVING Priority<span class="ls-permlink"><a href="#L4_RECVING"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the L4 Receiving Hook.<br/><br/> The L4 Receiving Hook is triggered when the TCP/IP connection receives data.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="L4_SENDING"><h3>Hook::L4_SENDING Priority<span class="ls-permlink"><a href="#L4_SENDING"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the L4 Sending Hook.<br/><br/> The L4 Sending Hook is triggered when the TCP/IP connection sends data.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="HTTP_BEGIN"><h3>Hook::HTTP_BEGIN Priority<span class="ls-permlink"><a href="#HTTP_BEGIN"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Begin Hook.<br/><br/> The HTTP Begin Hook is triggered when the TCP/IP connection begins an HTTP Session.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="RECV_REQ_HEADER"><h3>Hook::RECV_REQ_HEADER Priority<span class="ls-permlink"><a href="#RECV_REQ_HEADER"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Receive Request Header Hook.<br/><br/> The HTTP Receive Request Header Hook is triggered when the web server receives a request header.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="URI_MAP"><h3>Hook::URI_MAP Priority<span class="ls-permlink"><a href="#URI_MAP"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP URI Map Hook.<br/><br/> The HTTP URI Map Hook is triggered when the web server maps a URI request to a context.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="HTTP_AUTH"><h3>Hook::HTTP_AUTH Priority<span class="ls-permlink"><a href="#HTTP_AUTH"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Authentication Hook.<br/><br/> The HTTP Authentication Hook is triggered after resource mapping and before handler processing. It occurs after HTTP built-in authentication, and can be used to perform additional authentication checking.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="RECV_REQ_BODY"><h3>Hook::RECV_REQ_BODY Priority<span class="ls-permlink"><a href="#RECV_REQ_BODY"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Receive Request Body Hook.<br/><br/> The HTTP Receive Request Body Hook is triggered when the web server receives request body data.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="RCVD_REQ_BODY"><h3>Hook::RCVD_REQ_BODY Priority<span class="ls-permlink"><a href="#RCVD_REQ_BODY"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Received Request Body Hook.<br/><br/> The HTTP Received Request Body Hook is triggered when the web server finishes receiving request body data.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="RECV_RESP_HEADER"><h3>Hook::RECV_RESP_HEADER Priority<span class="ls-permlink"><a href="#RECV_RESP_HEADER"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Receive Response Header Hook.<br/><br/> The HTTP Receive Response Header Hook is triggered when the web server creates the response header.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="RECV_RESP_BODY"><h3>Hook::RECV_RESP_BODY Priority<span class="ls-permlink"><a href="#RECV_RESP_BODY"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Receive Response Body Hook.<br/><br/> The HTTP Receive Response Body Hook is triggered when the web server backend receives the response body.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="RCVD_RESP_BODY"><h3>Hook::RCVD_RESP_BODY Priority<span class="ls-permlink"><a href="#RCVD_RESP_BODY"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Received Response Body Hook.<br/><br/> The HTTP Received Response Body Hook is triggered when the web server backend finishes receiving the response body.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="HANDLER_RESTART"><h3>Hook::HANDLER_RESTART Priority<span class="ls-permlink"><a href="#HANDLER_RESTART"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Handler Restart Hook.<br/><br/> The HTTP Handler Restart Hook is triggered when the web server needs to discard the current response and start processing from beginning, for example, when an internal redirect has been requested.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="SEND_RESP_HEADER"><h3>Hook::SEND_RESP_HEADER Priority<span class="ls-permlink"><a href="#SEND_RESP_HEADER"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Send Response Header Hook.<br/><br/> The HTTP Send Response Header Hook is triggered when the web server is ready to send the response header.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="SEND_RESP_BODY"><h3>Hook::SEND_RESP_BODY Priority<span class="ls-permlink"><a href="#SEND_RESP_BODY"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Send Response Body Hook.<br/><br/> The HTTP Send Response Body Hook is triggered when the web server is going to send the response body.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="HTTP_END"><h3>Hook::HTTP_END Priority<span class="ls-permlink"><a href="#HTTP_END"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the HTTP Session End Hook.<br/><br/> The HTTP Session End Hook is triggered when the HTTP connection has ended.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="MAIN_INITED"><h3>Hook::MAIN_INITED Priority<span class="ls-permlink"><a href="#MAIN_INITED"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the Main Initialized Hook.<br/><br/> The Main Initialized Hook is triggered once upon startup, after the server configuration and initialization is completed by the main (controller) process, and before any requests are serviced.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="MAIN_PREFORK"><h3>Hook::MAIN_PREFORK Priority<span class="ls-permlink"><a href="#MAIN_PREFORK"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the Main Prefork Hook.<br/><br/> The Main Prefork Hook is triggered by the main (controller) process immediately before a new worker process is started (forked). This is called for each worker, and may happen during system startup, or if a worker has been restarted.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="MAIN_POSTFORK"><h3>Hook::MAIN_POSTFORK Priority<span class="ls-permlink"><a href="#MAIN_POSTFORK"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the Main Postfork Hook.<br/><br/> The Main Postfork Hook is triggered by the main (controller) process immediately after a new worker process has been started (forked). This is called for each worker, and may happen during system startup, or if a worker has been restarted.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="WORKER_POSTFORK"><h3>Hook::WORKER_POSTFORK Priority<span class="ls-permlink"><a href="#WORKER_POSTFORK"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the Worker Postfork Hook.<br/><br/> The Worker Postfork Hook is triggered by a worker process after being created by the main (controller) process. Note that a corresponding Main Postfork Hook may be called by the main process either before or after this callback.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="WORKER_ATEXIT"><h3>Hook::WORKER_ATEXIT Priority<span class="ls-permlink"><a href="#WORKER_ATEXIT"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the Worker At Exit Hook.<br/><br/> The Worker At Exit Hook is triggered by a worker process just prior to exiting. It is the last hook point to be called by a worker.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="MAIN_ATEXIT"><h3>Hook::MAIN_ATEXIT Priority<span class="ls-permlink"><a href="#MAIN_ATEXIT"></a></span></h3></header><h4>Description</h4><p>Sets the priority for this module callback within the Main At Exit Hook.<br/><br/> The Main At Exit Hook is triggered by the main (controller) process just prior to exiting. It is the last hook point to be called by the main process.<br/><br/> It will only take effect if the module has a hook point here. If it is not set, the priority will be the default value defined in the module.</p> <h4>Syntax</h4><p>Integer value from -6000 to 6000. Lower value means higher priority.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="listenerModules"><h3>Listener Modules<span class="ls-permlink"><a href="#listenerModules"></a></span></h3></header><h4>Description</h4><p>Listener module configuration data is, by default inherited from the Server module configuration. The Listener Modules are limited to the TCP/IP Layer 4 hooks.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="moduleEnabled_lst"><h3>Enable Module<span class="ls-permlink"><a href="#moduleEnabled_lst"></a></span></h3></header><h4>Description</h4><p>Enables module hooks at the Listener level. This setting will only take effect if the module has TCP/IP level hooks (L4_BEGSESSION, L4_ENDSESSION, L4_RECVING, L4_SENDING).<br/><br/> Default value: Inherit Server level setting</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="vhModules"><h3>Virtual Host Modules<span class="ls-permlink"><a href="#vhModules"></a></span></h3></header><h4>Description</h4><p>Virtual Host module configuration data is, by default inherited from the Server module configuration. The Virtual Host Modules are limited to the HTTP level hooks.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="moduleEnabled_vh"><h3>Enable Module<span class="ls-permlink"><a href="#moduleEnabled_vh"></a></span></h3></header><h4>Description</h4><p>Enables module hooks at the Virtual Host level. This setting will only take effect if the module has HTTP level hooks.<br/><br/> Default value: Inherit Server level setting</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="vhModuleUrlFilters"><h3>Virtual Host Module Context<span class="ls-permlink"><a href="#vhModuleUrlFilters"></a></span></h3></header><h4>Description</h4><p>It's a centralized place to customize module settings for virtual host contexts. Settings for a context URI will override the virtual host or the server level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span></h3></header><h4>Description</h4><p>Specifies the URI for this context.</p> <h4>Syntax</h4><p>The URI can be a plain URI (starting with "/") or a Perl compatible regular expression URI (starting with "exp:"). If a plain URI ends with a "/", then this context will include all sub-URIs under this URI. If the context maps to a directory on the file system, a trailing "/" must be added.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#location">Location</a></span></p> </article> </div>
</section>
</article></div><button class="doc-back-to-top" type="button" aria-label="Back to top" data-back-to-top><svg viewBox="0 0 24 24" aria-hidden="true" focusable="false"><path d="M12 19V5" /><path d="m6 11 6-6 6 6" /></svg><span class="sr-only">Back to top</span></button><footer class="copyright">Copyright © 2013-2026. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div>
</body>
</html>