| Server IP : 202.155.9.250 / Your IP : 216.73.217.177 Web Server : LiteSpeed System : Linux srv339029361 5.15.0-177-generic #187-Ubuntu SMP Sat Apr 11 22:54:33 UTC 2026 x86_64 User : grabn6394 ( 1016) PHP Version : 8.0.30 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : ON Directory : /proc/self/root/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 - Server General</title>
<meta name="description" content="OpenLiteSpeed Users' Manual - Server General." />
<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="ServGeneral_Help.html" data-lang="en-US" selected>English</option><option value="es-ES/ServGeneral_Help.html" data-lang="es-ES">Español</option><option value="de-DE/ServGeneral_Help.html" data-lang="de-DE">Deutsch</option><option value="fr-FR/ServGeneral_Help.html" data-lang="fr-FR">Français</option><option value="zh-CN/ServGeneral_Help.html" data-lang="zh-CN">简体中文</option><option value="ja-JP/ServGeneral_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. 4</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 class="current" 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 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"> </div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="ServLog_Help.html">Server Log</a> »</div></div>
<header class="doc-page-header"><h1>Server General</h1><div class="doc-page-intro">General settings for the whole server. When path information is required in a setting, it can be either absolute or relative to $SERVER_ROOT. $SERVER_ROOT is the location where LiteSpeed web server has been installed (your_home_dir/lsws or /opt/lsws, for example). The server executable is under $SERVER_ROOT/bin.</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">Server Process</h3><ul class="doc-toc__links"><li><a href="#serverName">Server Name</a></li><li><a href="#httpdWorkers">Number of Workers</a></li><li><a href="#runningAs">Running As</a></li><li><a href="#serverPriority">Priority</a></li><li><a href="#cpuAffinity">CPU Affinity</a></li><li><a href="#enableLVE">CloudLinux</a></li><li><a href="#inMemBufSize">Memory I/O Buffer Size</a></li><li><a href="#swappingDir">Swapping Directory</a></li><li><a href="#autoFix503">Auto Fix 503 Error</a></li><li><a href="#enableh2c">Enable HTTP/2 Over Cleartext TCP</a></li><li><a href="#gracefulRestartTimeout">Graceful Restart Timeout (secs)</a></li><li><a href="#statDir">Statistics Output Directory</a></li><li><a href="#jsonReports">Output JSON reports</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading">General Settings</h3><ul class="doc-toc__links"><li><a href="#mime">MIME Settings</a></li><li><a href="#mimesuffix">Suffixes</a></li><li><a href="#mimetype">MIME Type</a></li><li><a href="#disableInitLogRotation">Disable Initial Log Rotation</a></li><li><a href="#showVersionNumber">Server Signature</a></li><li><a href="#enableIpGeo">Enable GeoLocation Lookup</a></li><li><a href="#useIpInProxyHeader">Use Client IP in Header</a></li><li><a href="#adminEmails">Administrator Email</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading">Index Files</h3><ul class="doc-toc__links"><li><a href="#indexFiles">Index Files</a></li><li><a href="#autoIndex">Auto Index</a></li><li><a href="#autoIndexURI">Auto Index URI</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading">Expires Settings</h3><ul class="doc-toc__links"><li><a href="#enableExpires">Enable Expires</a></li><li><a href="#expiresDefault">Expires Default</a></li><li><a href="#expiresByType">Expires By Type</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading">Rewrite Control</h3><ul class="doc-toc__links"><li><a href="#autoLoadHtaccess">Auto Load from .htaccess</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading"><a href="#fileUpload">File Upload</a></h3><ul class="doc-toc__links"><li><a href="#uploadTmpDir">Temporary File Path</a></li><li><a href="#uploadTmpFilePermission">Temporary File Permission</a></li><li><a href="#uploadPassByPath">Pass Upload Data by File Path</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading"><a href="#geolocationDB">MaxMind GeoIP DB</a></h3><ul class="doc-toc__links"><li><a href="#geoipDBFile">DB File Path</a></li><li><a href="#geoipDBName">DB Name</a></li><li><a href="#maxMindDBEnv">Environment Variables</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading">IP2Location DB</h3><ul class="doc-toc__links"><li><a href="#ip2locDBFile">IP2Location DB File Path</a></li><li><a href="#ip2locDBCache">DB Cache Type</a></li></ul></section>
</section>
<section class="doc-content-flow"><div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="serverName"><h3>Server Name<span class="ls-permlink"><a href="#serverName"></a></span></h3></header><h4>Description</h4><p>A unique name for this server. If empty, server hostname will be used by default.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="httpdWorkers"><h3>Number of Workers<span class="ls-permlink"><a href="#httpdWorkers"></a></span></h3></header><h4>Description</h4><p>Specifies the number of httpd workers.</p> <h4>Syntax</h4><p>Integer value between 1 and 16.</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Set an appropriate number to suit your needs. Adding more workers may not necessarily mean better performance.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="runningAs"><h3>Running As<span class="ls-permlink"><a href="#runningAs"></a></span></h3></header><h4>Description</h4><p>Specifies the user/group that the server process runs as. This is set using the parameters "--with-user" and "--with-group" when running the configure command before installation. To reset these values, you must rerun the configure command and reinstall.</p> <h4>Apply</h4><p>Reinstall required.</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--security">Security</span> Server should not run as a privileged user such as "root". It is critical that the server is configured to run with a un-privileged user/group combination that does not have login/shell access. A user/group of <span class="val">nobody</span> is generally a good choice.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="serverPriority"><h3>Priority<span class="ls-permlink"><a href="#serverPriority"></a></span></h3></header><h4>Description</h4><p>Specifies priority of the server processes. Value ranges from <span class="val">-20</span> to <span class="val">20</span>. A lower number means higher priority.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Usually a higher priority leads to slightly higher web performance on a busy server. Do not set priority higher than that of database processes.</p> <h4>See Also</h4><p class="ls-text-small">External App <span class="tagl"><a href="ExtApp_Help.html#extAppPriority">Priority</a></span>, <span class="tagl"><a href="ServSecurity_Help.html#CGIPriority">CGI Priority</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="cpuAffinity"><h3>CPU Affinity<span class="ls-permlink"><a href="#cpuAffinity"></a></span></h3></header><h4>Description</h4><p>CPU affinity binds a process to one or more CPUs (cores). It is beneficial for a process to always use the same CPU because then the process can make use of data left in CPU cache. If the process moves to a different CPU, there is no use of CPU cache and unnecessary overhead is required.<br/><br/> The CPU Affinity setting controls how many CPUs (cores) one server process will be associated with. The minimum value is <span class="val">0</span>, which will disable this feature. The maximum value is the number of cores the server has. Generally, <span class="val">1</span> is the best setting because it creates the strictest use of CPU affinity and thus makes the most use of CPU cache.<br/><br/> Default value: 0</p> <h4>Syntax</h4><p>Integer value from 0 to 64. (0 will disable this feature)</p> <h4>Apply</h4><p>Reinstall required.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="enableLVE"><h3>CloudLinux<span class="ls-permlink"><a href="#enableLVE"></a></span></h3></header><h4>Description</h4><p>Specifies whether to enable CloudLinux's Lightweight Virtual Environment (LVE) when it exists. You can use LiteSpeed with LVE to achieve better resource management. For more information, please check <a href="http://www.cloudlinux.com" target="_blank" rel="noopener noreferrer">http://www.cloudlinux.com</a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="inMemBufSize"><h3>Memory I/O Buffer Size<span class="ls-permlink"><a href="#inMemBufSize"></a></span></h3></header><h4>Description</h4><p>Specifies the maximum buffer size that is used to store a request body and its dynamically generated response. When this limit is reached, the server will start to create temporary swapping files under <span class="tagl"><a href="#swappingDir">Swapping Directory</a></span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Set the buffer size large enough to accommodate all concurrent requests/replies to avoid memory to disk swapping. If there is frequent I/O activity to the swap directory, by default /tmp/lshttpd/swap/, this buffer size is too low and LiteSpeed is swapping to disk.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#swappingDir">Swapping Directory</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="swappingDir"><h3>Swapping Directory<span class="ls-permlink"><a href="#swappingDir"></a></span></h3></header><h4>Description</h4><p>Specifies the directory where the swapping files should be placed. When the server is started in chroot mode, this directory is relative to the new root directory, otherwise it is relative to the real root directory.<br/><br/> The server uses its own virtual memory to reduce system memory usage. Virtual memory and disk swapping are used to store large request bodies and dynamically generated responses. The swapping directory should be placed on a disk with enough space.<br/><br/> Default value: /tmp/lshttpd/swap</p> <h4>Syntax</h4><p>Absolute path</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Place the swapping directory on a separate disk or increase Memory I/O Buffer Size to eliminate swapping.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#inMemBufSize">Memory I/O Buffer Size</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="autoFix503"><h3>Auto Fix 503 Error<span class="ls-permlink"><a href="#autoFix503"></a></span></h3></header><h4>Description</h4><p>Specifies whether to try to fix the "503 Service Unavailable" error by restarting the server gracefully. A "503" error is usually caused by malfunctioning external applications and a web server restart can often fix the error temporarily. If enabled, the server will restart automatically whenever there are more than 30 "503" errors within a 30 seconds span.<br/><br/> Default value: <span class="val">No</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="enableh2c"><h3>Enable HTTP/2 Over Cleartext TCP<span class="ls-permlink"><a href="#enableh2c"></a></span></h3></header><h4>Description</h4><p>Specifies whether to enable HTTP/2 over non-encrypted TCP connections. Default is disabled.</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="gracefulRestartTimeout"><h3>Graceful Restart Timeout (secs)<span class="ls-permlink"><a href="#gracefulRestartTimeout"></a></span></h3></header><h4>Description</h4><p>During a graceful restart, even after the new server instance is up, the old instance will continue to handle existing requests. This timeout defines how long the previous instance shall wait before exit. Default value is 300 seconds. -1 means wait forever. 0 means no wait and abort immediately.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="statDir"><h3>Statistics Output Directory<span class="ls-permlink"><a href="#statDir"></a></span></h3></header><h4>Description</h4><p>The directory where the Real-Time Stats report file will be written. The default directory is <b>/tmp/lshttpd/</b> .</p> <h4>Syntax</h4><p>Absolute path</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--info">Information</span> During server operation, the .rtreport file will be written to every second. To avoid unnecessary disk writes, set this to a RAM Disk.<br/> The .rtreport file can be used with 3rd party monitoring software to track server health.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="jsonReports"><h3>Output JSON reports<span class="ls-permlink"><a href="#jsonReports"></a></span></h3></header><h4>Description</h4><p>Output additional JSON formatted report files, with the .json extension, to the /tmp/lshttpd directory.<br/><br/> Default value: <span class="val">No</span></p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Example</h4><div class="ls-example">When set to <span class="val">Yes</span>, .status.json and .rtreport.json, .rtreport.2.json, etc report files will be created in addition to the usual .status and .rtreport, .rtreport.2, etc report files.</div><h4>Tips</h4><p><span class="ls-badge ls-badge--info">Information</span> This is useful for application developers who may want to integrate LiteSpeed status and real-time reports into their applications using standard JSON processing tools built-in to most programming languages.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="mime"><h3>MIME Settings<span class="ls-permlink"><a href="#mime"></a></span></h3></header><h4>Description</h4><p>Specifies the file that contains the MIME settings for this server. It is always relative to the real root when an absolute path is given in chroot mode. Click on the filename to view/edit the detailed MIME entries.</p> <h4>Syntax</h4><p>Filename which can be an absolute path or a relative path to $SERVER_ROOT.</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--info">Information</span> Click the filename to edit the MIME settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="mimesuffix"><h3>Suffixes<span class="ls-permlink"><a href="#mimesuffix"></a></span></h3></header><h4>Description</h4><p>You can list multiple suffixes for the same MIME type, using comma to separate.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="mimetype"><h3>MIME Type<span class="ls-permlink"><a href="#mimetype"></a></span></h3></header><h4>Description</h4><p>A MIME type consists of a type and subtype in the format of "type/subtype".</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="disableInitLogRotation"><h3>Disable Initial Log Rotation<span class="ls-permlink"><a href="#disableInitLogRotation"></a></span></h3></header><h4>Description</h4><p>Specifies whether to enable/disable rotation of server error log file at startup. Initial log rotation is enabled by default when using value "Not Set".</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="showVersionNumber"><h3>Server Signature<span class="ls-permlink"><a href="#showVersionNumber"></a></span></h3></header><h4>Description</h4><p>Specifies whether to show the server signature and version number in the response header's "Server" value. There are three options: when set to <span class="val">Hide Version</span>, only <span class="val">LiteSpeed</span> is shown. When set to <span class="val">Show Version</span>, LiteSpeed and the version number are shown. When set to <span class="val">Hide Full Header</span>, the entire Server header will not be shown in the response header.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--security">Security</span> Set to <span class="val">Hide Version</span> if you do not wish to expose the server version number.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span></h3></header><h4>Description</h4><p> Specifies whether to enable/disable IP Geolocation lookup. Can be set at server, virtual host, or context level. IP Geolocation is disabled by default when using value "Not Set".</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="ServGeneral_Help.html#useIpInProxyHeader">Use Client IP in Header</a></span>, <span class="tagl"><a href="ServGeneral_Help.html#geoipDBFile">DB File Path</a></span>,</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="useIpInProxyHeader"><h3>Use Client IP in Header<span class="ls-permlink"><a href="#useIpInProxyHeader"></a></span></h3></header><h4>Description</h4><p>Specifies whether to use the first most valid IP IP address listed in the "X-Forwarded-For" HTTP request header for all IP address-related features, including connection/bandwidth throttling, access control, and IP geolocation.<br/><br/> This feature is useful if your web server is behind a load balancer or a proxy server. If you select <span class="val">Trusted IP Only</span>, then X-Forwarded-For IP will be used only when the request is coming from trusted IPs defined in the server-level <span class="tagl"><a href="ServSecurity_Help.html#accessControl_allow">Allowed List</a></span>.<br/><br/> <span class="val">Keep Header from Trusted IP</span> is the same as <span class="val">Trusted IP Only</span>, but the X-Forwarded-For header used for the backend will not be modified to include the connecting peer address.<br/><br/> <span class="val">Use Last IP (for AWS ELB)</span> will use the last IP address in the "X-Forwarded-For" list. Select this option if you are using AWS Elastic Load Balancer or expect the real IP to appended to the end of the "X-Forwarded-For" list.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="adminEmails"><h3>Administrator Email<span class="ls-permlink"><a href="#adminEmails"></a></span></h3></header><h4>Description</h4><p>Specifies the server administrator's email address(es). If specified, administrators will be notified by email of important events (for example, when the LiteSpeed service is restarted automatically due to crash detection or when license is expiring).</p> <h4>Syntax</h4><p>Comma delimited list of email address.</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--info">Information</span> Email alert feature will only work if the server has an active MX server such as postfix, exim, or sendmail.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="indexFiles"><h3>Index Files<span class="ls-permlink"><a href="#indexFiles"></a></span></h3></header><h4>Description</h4><p>Specifies names of index files that will be searched sequentially when a URL is mapped to a directory. You can customize it at the server, virtual host, and context level.</p> <h4>Syntax</h4><p>Comma-delimited list of index filenames.</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Only set index files that you need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="autoIndex"><h3>Auto Index<span class="ls-permlink"><a href="#autoIndex"></a></span></h3></header><h4>Description</h4><p>Specifies whether to generate a directory index on the fly when index files listed in <span class="tagl"><a href="#indexFiles">Index Files</a></span> are not available in a directory. This option is customizable at the virtual host and context level, and is inherited along the directory tree until it is explicitly overridden. You can customize the generated index page. Please check online wiki How-tos.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--security">Security</span> It is recommended to turn off Auto Index wherever possible to prevent revealing confidential data.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#indexFiles">Index Files</a></span>, <span class="tagl"><a href="#autoIndexURI">Auto Index URI</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="autoIndexURI"><h3>Auto Index URI<span class="ls-permlink"><a href="#autoIndexURI"></a></span></h3></header><h4>Description</h4><p>Specifies the URI that will be used to generate the index page when index files listed in <span class="tagl"><a href="#indexFiles">Index Files</a></span> are not available in a directory. LiteSpeed Web Server uses an external script to generate the index page providing the maximum customization flexibility. The default script produces an index page with same look as Apache's. To customize the generated index page, please read online wiki How-tos. The directory to be indexed is passed to the script via an environment variable "LS_AI_PATH".</p> <h4>Syntax</h4><p>URI</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#indexFiles">Index Files</a></span>, <span class="tagl"><a href="#autoIndex">Auto Index</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="enableExpires"><h3>Enable Expires<span class="ls-permlink"><a href="#enableExpires"></a></span></h3></header><h4>Description</h4><p>Specifies whether to generate an Expires header for static files. If enabled, an Expires header will be generated based on <span class="tagl"><a href="#expiresDefault">Expires Default</a></span> and <span class="tagl"><a href="#expiresByType">Expires By Type</a></span>.<br/><br/> This can be set at server, virtual host and context level. Lower level settings will override higher level ones, i.e. context settings will override virtual host settings and virtual host settings will override server settings.</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="expiresDefault"><h3>Expires Default<span class="ls-permlink"><a href="#expiresDefault"></a></span></h3></header><h4>Description</h4><p>Specifies default settings for Expires header generation. This setting takes effect when <span class="tagl"><a href="#enableExpires">Enable Expires</a></span> is set to "Yes". It can be overridden by <span class="tagl"><a href="#expiresByType">Expires By Type</a></span>. Do not set this default at the server or virtual host level unless you have to, since it will generate Expires headers for all pages. Most of time this should be set at the context level for certain directories that do not change often. If there is no default setting, no Expires header will be generated for types not specified in <span class="tagl"><a href="#expiresByType">Expires By Type</a></span>.</p> <h4>Syntax</h4><p>A|Mseconds<br/> The file will expire after base time(A|M) plus specified seconds. Base time "A" sets the value to the client's access time and "M" to the file's last modified time.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="expiresByType"><h3>Expires By Type<span class="ls-permlink"><a href="#expiresByType"></a></span></h3></header><h4>Description</h4><p>Specifies Expires header settings for individual MIME types.</p> <h4>Syntax</h4><p>Comma delimited list of "MIME-type=A|Mseconds". The file will expire after base time (A|M) plus specified seconds.<br/><br/> Base time "A" sets the value to the client's access time and "M" to the file's last modified time. MIME-type accepts wildcard "*", like image/*.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="autoLoadHtaccess"><h3>Auto Load from .htaccess<span class="ls-permlink"><a href="#autoLoadHtaccess"></a></span></h3></header><h4>Description</h4><p>Autoload rewrite rules contained in a directory's .htaccess file when first accessing that directory if an HttpContext for that directory using the <b>rewritefile</b> directive does not already exist. Once initially loaded, a graceful restart must be performed for any further changes to that .htaccess file to take effect.<br/><br/> Virtual Host-level setting overrides Server-level setting. Default values:<br/><br/> <b>Server-level:</b> No<br/><br/> <b>VH-Level:</b> 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="fileUpload"><h3>File Upload<span class="ls-permlink"><a href="#fileUpload"></a></span></h3></header><h4>Description</h4><p>Provides additional security functionality when uploading files by using a Request Body Parser to parse files to a server local directory where they can be easily scanned for malicious intent by third party modules. Request Body Parser is used when <span class="tagl"><a href="#uploadPassByPath">Pass Upload Data by File Path</a></span> is enabled or a module calls LSIAPI’s set_parse_req_body in the LSI_HKPT_HTTP_BEGIN level. API examples provided in source package.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#HTTP_BEGIN">Hook::HTTP_BEGIN Priority</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="uploadTmpDir"><h3>Temporary File Path<span class="ls-permlink"><a href="#uploadTmpDir"></a></span></h3></header><h4>Description</h4><p>Temporary directory where files being uploaded to server will be stored while request body parser is working. Default value is <span class="val">/tmp/lshttpd/</span>.</p> <h4>Syntax</h4><p>Absolute path or path starting with $SERVER_ROOT (for Server and VHost levels) or $VH_ROOT (for VHost levels).</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="uploadTmpFilePermission"><h3>Temporary File Permission<span class="ls-permlink"><a href="#uploadTmpFilePermission"></a></span></h3></header><h4>Description</h4><p>Determines file permissions used for files stored in temporary directory. Server level setting is global, can be overridden at VHost level.</p> <h4>Syntax</h4><p>3 digits octet number. Default value is 666.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="uploadPassByPath"><h3>Pass Upload Data by File Path<span class="ls-permlink"><a href="#uploadPassByPath"></a></span></h3></header><h4>Description</h4><p>Specify whether or not to pass upload file data by path. If enabled, file path along with some other information is sent to backend handler instead of file itself when uploading. This saves on CPU resources and file transfer time but requires some updates to backend to implement. If disabled, file content will be transferred to backend handler, request body is still parsed to files.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Enable this to speed up file upload processing if backward compatibility is not an issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="geolocationDB"><h3>MaxMind GeoIP DB<span class="ls-permlink"><a href="#geolocationDB"></a></span></h3></header><h4>Description</h4><p>Multiple MaxMind geolocation databases can be specified here. MaxMind has the following type of DBs: Country, Region, City, Organization, ISP and Netspeed. If multiple databases of types "Country", "Region", and "City" are configured, the last configuration will be effective.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="geoipDBFile"><h3>DB File Path<span class="ls-permlink"><a href="#geoipDBFile"></a></span></h3></header><h4>Description</h4><p>Specifies the path to MaxMind GeoIP database.</p> <h4>Syntax</h4><p>Absolute path</p> <h4>Example</h4><div class="ls-example">/usr/local/share/GeoIP/GeoLite2-Country.mmdb</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="geoipDBName"><h3>DB Name<span class="ls-permlink"><a href="#geoipDBName"></a></span></h3></header><h4>Description</h4><p>MaxMind GeoIP database name. As of GeoIP2, this setting is required.<br/><br/> When upgrading from a GeoIP to a GeoIP2, using values "COUNTRY_DB", "CITY_DB", or "ASN_DB" for this setting will automatically populate PHP's $_SERVER variable with some GeoIP compatible entries (listed by DB Name value below) to help ease this transition.<br/><br/> <b>CITY_DB:</b> 'GEOIP_COUNTRY_CODE', 'GEOIP_COUNTRY_NAME', 'GEOIP_CONTINENT_CODE', 'GEOIP_COUNTRY_CONTINENT', 'GEOIP_DMA_CODE', 'GEOIP_METRO_CODE', 'GEOIP_LATITUDE', 'GEOIP_LONGITUDE', 'GEOIP_POSTAL_CODE', and 'GEOIP_CITY'.<br/> <b>COUNTRY_DB:</b> 'GEOIP_COUNTRY_CODE', 'GEOIP_COUNTRY_NAME', 'GEOIP_CONTINENT_CODE', and 'GEOIP_COUNTRY_CONTINENT'.<br/> <b>ASN_DB:</b> 'GEOIP_ORGANIZATION' and 'GEOIP_ISP'.</p> <h4>Example</h4><div class="ls-example">COUNTRY_DB</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="maxMindDBEnv"><h3>Environment Variables<span class="ls-permlink"><a href="#maxMindDBEnv"></a></span></h3></header><h4>Description</h4><p>Assign the results of database lookups to environment variables.</p> <h4>Syntax</h4><p>Variable_Name mapped_DB_data<br/><br/> One entry per line. Path to data can use map keys or 0-based array indexes, both being separated by /.</p> <h4>Example</h4><div class="ls-example">COUNTRY_CODE COUNTRY_DB/country/iso_code<br/> REGION_CODE CITY_DB/subdivisions/0/iso_code</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="ip2locDBFile"><h3>IP2Location DB File Path<span class="ls-permlink"><a href="#ip2locDBFile"></a></span></h3></header><h4>Description</h4><p>The location of a valid database file.</p> <h4>Syntax</h4><p>Filename which can be an absolute path or a relative path to $SERVER_ROOT.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="ip2locDBCache"><h3>DB Cache Type<span class="ls-permlink"><a href="#ip2locDBCache"></a></span></h3></header><h4>Description</h4><p>The caching method used. The default value is <span class="val">Memory</span>.</p> <h4>Syntax</h4><p>Select from drop down list</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>