| Server IP : 202.155.9.250 / Your IP : 216.73.216.236 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 : lucky4072 ( 1024) 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 : /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 - Virtual Host General</title>
<meta name="description" content="OpenLiteSpeed Users' Manual - Virtual Host 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="VHGeneral_Help.html" data-lang="en-US" selected>English</option><option value="es-ES/VHGeneral_Help.html" data-lang="es-ES">Español</option><option value="de-DE/VHGeneral_Help.html" data-lang="de-DE">Deutsch</option><option value="fr-FR/VHGeneral_Help.html" data-lang="fr-FR">Français</option><option value="zh-CN/VHGeneral_Help.html" data-lang="zh-CN">简体中文</option><option value="ja-JP/VHGeneral_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 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 class="current" 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="VirtualHosts_Help.html">Virtual Host Registration</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="VHSecurity_Help.html">Virtual Host Security</a> »</div></div>
<header class="doc-page-header"><h1>Virtual Host General</h1></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">Core Settings</h3><ul class="doc-toc__links"><li><a href="#docRoot">Document Root</a></li><li><a href="#vhadminEmails">Administrator Email</a></li><li><a href="#vhEnableGzip">Enable Compression</a></li><li><a href="#vhEnableBr">Enable Brotli Compression</a></li><li><a href="#enableIpGeo">Enable GeoLocation Lookup</a></li><li><a href="#cgroups">cgroups</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading">Virtual Host Log</h3><ul class="doc-toc__links"><li><a href="#logUseServer">Use Server's Log</a></li><li><a href="#vhlog_fileName">File Name</a></li><li><a href="#vhlog_logLevel">Log Level</a></li><li><a href="#log_rollingSize">Rolling Size (bytes)</a></li><li><a href="#log_keepDays">Keep Days</a></li><li><a href="#log_compressArchive">Compress Archive</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading">Access Log</h3><ul class="doc-toc__links"><li><a href="#aclogUseServer">Log Control</a></li><li><a href="#vhaccessLog_fileName">File Name</a></li><li><a href="#accessLog_pipedLogger">Piped Logger</a></li><li><a href="#accessLog_logFormat">Log Format</a></li><li><a href="#accessLog_logHeader">Log Headers</a></li><li><a href="#log_rollingSize">Rolling Size (bytes)</a></li><li><a href="#log_keepDays">Keep Days</a></li><li><a href="#log_compressArchive">Compress Archive</a></li><li><a href="#accessLog_bytesLog">Bytes Log</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="#indexUseServer">Use Server Index Files</a></li><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"><a href="#errPage">Customized Error Pages</a></h3><ul class="doc-toc__links"><li><a href="#errCode">Error Code</a></li><li><a href="#errURL">URL</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"><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">Script Handler Definition</h3><ul class="doc-toc__links"><li><a href="#suffix">Suffixes</a></li><li><a href="#shType">Handler Type</a></li><li><a href="#shHandlerName">Handler Name</a></li></ul></section>
<section class="doc-toc__row"><h3 class="doc-toc__heading">Expire 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">php.ini Override</h3><ul class="doc-toc__links"><li><a href="#phpIniOverride">php.ini Override</a></li></ul></section>
</section>
<section class="doc-content-flow"><div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="docRoot"><h3>Document Root<span class="ls-permlink"><a href="#docRoot"></a></span></h3></header><h4>Description</h4><p>Specifies the document root for this virtual host. <span class="val">$VH_ROOT/html</span> is recommended. This directory is referred to as $DOC_ROOT in contexts.</p> <h4>Syntax</h4><p>A path which can be absolute, relative to $SERVER_ROOT, or relative to $VH_ROOT.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="vhadminEmails"><h3>Administrator Email<span class="ls-permlink"><a href="#vhadminEmails"></a></span></h3></header><h4>Description</h4><p>Specifies email address(es) of the administrator(s) of this virtual host.</p> <h4>Syntax</h4><p>Comma separated list of email addresses</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="vhEnableGzip"><h3>Enable Compression<span class="ls-permlink"><a href="#vhEnableGzip"></a></span></h3></header><h4>Description</h4><p>Specifies whether to enable GZIP/Brotli compression for this virtual host. This setting is only effective when compression is enabled at the server level. Compression settings are configured at the server level (Tuning > GZIP/Brotli Compression).</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="ServTuning_Help.html#enableGzipCompress">Enable Compression</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="vhEnableBr"><h3>Enable Brotli Compression<span class="ls-permlink"><a href="#vhEnableBr"></a></span></h3></header><h4>Description</h4><p>Specifies whether to enable Brotli compression for this virtual host. This setting is only effective when <span class="tagl"><a href="#brStaticCompressLevel">Brotli Compression Level (Static File)</a></span> is set to a non-zero value at the server level.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="ServTuning_Help.html#brStaticCompressLevel">Brotli Compression Level (Static File)</a></span></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="cgroups"><h3>cgroups<span class="ls-permlink"><a href="#cgroups"></a></span></h3></header><h4>Description</h4><p>A Linux kernel feature that limits, accounts for, and isolates the resource usage (CPU, memory, disk I/O, network, etc.) of a collection of processes. You must be running cgroups v2 which is determined by the existence of the file <span class="val">/sys/fs/cgroup/cgroup.controllers</span>.<br/><br/> Setting this to <span class="val">Disabled</span> at the Server level will disable this setting server-wide. In all other cases, the Server level setting can be overridden at the Virtual Host level.<br/><br/> Default values:<br/> <b>Server level:</b> Off<br/> <b>VH level:</b> Inherit Server level setting</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="logUseServer"><h3>Use Server's Log<span class="ls-permlink"><a href="#logUseServer"></a></span></h3></header><h4>Description</h4><p>Specifies whether to put log messages from this virtual host into the server log file instead of creating its own log file.</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="vhlog_fileName"><h3>File Name<span class="ls-permlink"><a href="#vhlog_fileName"></a></span></h3></header><h4>Description</h4><p>Specifies the path for the log file.</p> <h4>Syntax</h4><p>Filename which can be an absolute path or a relative path to $SERVER_ROOT, $VH_ROOT.</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Place the log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="vhlog_logLevel"><h3>Log Level<span class="ls-permlink"><a href="#vhlog_logLevel"></a></span></h3></header><h4>Description</h4><p>Specifies the level of logging. Available levels (from high to low) are <span class="val">ERROR</span>, <span class="val">WARNING</span>, <span class="val">NOTICE</span>, <span class="val">INFO</span>, and <span class="val">DEBUG</span>. Only messages with a level higher than or equal to the current setting will be logged. If you want to set it to DEBUG</span>, you must set the server log level to <span class="val">DEBUG</span> as well. The level of debugging is controlled solely at the server level by <span class="tagl"><a href="ServGeneral_Help.html#log_debugLevel">Debug Level</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Unless <span class="tagl"><a href="ServGeneral_Help.html#log_debugLevel">Debug Level</a></span> is set to a level other than <span class="val">NONE</span>, <span class="val">DEBUG</span> log level does not have any performance impact and is recommended.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="ServGeneral_Help.html#log_debugLevel">Debug Level</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="log_rollingSize"><h3>Rolling Size (bytes)<span class="ls-permlink"><a href="#log_rollingSize"></a></span></h3></header><h4>Description</h4><p>Specifies when the current log file needs to be rolled over, also known as log rotation. When the file size is over the rollover limit, the active log file will be renamed to log_name.mm_dd_yyyy(.sequence) in the same directory and a new active log file will be created. The actual size of the rotated log file once it is created will sometimes be a little bigger than this size limit. Set to <span class="val">0</span> to disable log rotation.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--info">Information</span> Append "K", "M", "G" to the number for kilo-, mega- and giga- bytes.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="log_keepDays"><h3>Keep Days<span class="ls-permlink"><a href="#log_keepDays"></a></span></h3></header><h4>Description</h4><p>Specifies how many days the access log file will be kept on disk. Only rotated log files older than the specified number of days will be deleted. The current log file will not be touched regardless how many days worth of data it contains. If you do not want to auto-delete stale and very old log files, set this to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="log_compressArchive"><h3>Compress Archive<span class="ls-permlink"><a href="#log_compressArchive"></a></span></h3></header><h4>Description</h4><p>Specifies whether to compress rotated log files in order to save disk space.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--info">Information</span> Log files are highly compressible and this is recommended to reduce disk usage for old logs.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="aclogUseServer"><h3>Log Control<span class="ls-permlink"><a href="#aclogUseServer"></a></span></h3></header><h4>Description</h4><p>Where the access log should be written. There are three options: <ol> <li>Write to the server's access log</li> <li>Create an access log for this virtual host</li> <li>Disable access logging</li> </ol></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="vhaccessLog_fileName"><h3>File Name<span class="ls-permlink"><a href="#vhaccessLog_fileName"></a></span></h3></header><h4>Description</h4><p>The access log filename.</p> <h4>Syntax</h4><p>Filename which can be an absolute path or a relative path to $SERVER_ROOT, $VH_ROOT.</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Put access log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="accessLog_pipedLogger"><h3>Piped Logger<span class="ls-permlink"><a href="#accessLog_pipedLogger"></a></span></h3></header><h4>Description</h4><p>Specifies the external application that will receive the access log data sent by LiteSpeed through a pipe on its STDIN stream (file handle is 0). When this field is specified, the access log will be sent only to the logger application and not the access log file specified in previous entry.<br/><br/> The logger application must be defined in <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> section first. Server-level access logging can only use an external logger application defined at the server level. Virtual host-level access logging can only use a logger application defined at the virtual host level.<br/><br/> The logger process is spawned in the same way as other external (CGI/FastCGI/LSAPI) processes. This means it will execute as the user ID specified in the virtual host's <span class="tagl"><a href="VirtualHosts_Help.html#setUidMode">External App Set UID Mode</a></span> settings and will never run on behalf of a privileged user.<br/><br/> LiteSpeed Web Server performs simple load balancing among multiple logger applications if more than one instance of a logger application is configured. LiteSpeed server always attempts to keep the number of logger applications as low as possible. Only when one logger application fails to process access log entries in time will the server attempt to spawn another instance of the logger application.<br/><br/> If a logger crashes, the web server will start another instance but the log data in the stream buffer will be lost. It is possible to lose log data if external loggers cannot keep up with the speed and volume of the log stream.</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="accessLog_logFormat"><h3>Log Format<span class="ls-permlink"><a href="#accessLog_logFormat"></a></span></h3></header><h4>Description</h4><p> Specifies the log format for the access log. When log format is set, it will override the <span class="tagl"><a href="#accessLog_logHeader">Log Headers</a></span> setting.</p> <h4>Syntax</h4><p>String. The syntax of log format is compatible with Apache 2.0's custom <a href="http://httpd.apache.org/docs/current/mod/mod_log_config.html#formats" target="_blank" rel="noopener noreferrer">log format</a>.</p> <h4>Example</h4><div class="ls-example"><b>Common Log Format (CLF)</b><br/> "%h %l %u %t \"%r\" %>s %b"<br/><br/> <b>Common Log Format with Virtual Host</b><br/> "%v %h %l %u %t \"%r\" %>s %b"<br/><br/> <b>NCSA extended/combined log format</b><br/> "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"<br/><br/> <b>Log cookie value of Foobar</b><br/> "%{Foobar}C"</div><h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#accessLog_logHeader">Log Headers</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="accessLog_logHeader"><h3>Log Headers<span class="ls-permlink"><a href="#accessLog_logHeader"></a></span></h3></header><h4>Description</h4><p>Specifies whether to log HTTP request headers: <span class="val">Referer</span>, <span class="val">UserAgent</span>, and <span class="val">Host</span>.</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--performance">Performance</span> Turn this off if you do not need these headers in the access log.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#accessLog_logFormat">Log Format</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="accessLog_bytesLog"><h3>Bytes Log<span class="ls-permlink"><a href="#accessLog_bytesLog"></a></span></h3></header><h4>Description</h4><p>Specifies the path to the bandwidth bytes log file. When specified, a cPanel compatible bandwidth log will be created. This will log the total bytes transferred for a request including both the request and reply bodies.</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--performance">Performance</span> Put the log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="indexUseServer"><h3>Use Server Index Files<span class="ls-permlink"><a href="#indexUseServer"></a></span></h3></header><h4>Description</h4><p>Specifies whether to use the server's index file settings. If set to <span class="val">Yes</span>, only the server's settings will be used. If set to <span class="val">No</span>, the server's settings will not be used. If set to <span class="val">Addition</span>, additional index files can be added to server's index file list for this virtual host. If you want to disable index files for this virtual host, you can set the value to <span class="val">No</span> and leave the index files field empty.</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="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="errPage"><h3>Customized Error Pages<span class="ls-permlink"><a href="#errPage"></a></span></h3></header><h4>Description</h4><p>Whenever the server has a problem processing a request, the server will return an error code and an html page as an error message to the web client. Error codes are defined in the HTTP protocol (see RFC 2616). LiteSpeed Web Server has a built-in default error page for each error code, but a customized page can be configured for each error code as well. These error pages can be even further customized to be unique for each virtual host.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="errCode"><h3>Error Code<span class="ls-permlink"><a href="#errCode"></a></span></h3></header><h4>Description</h4><p>Specifies the HTTP status code for the error page. Only the selected HTTP status code will have this customized error page.</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="errURL"><h3>URL<span class="ls-permlink"><a href="#errURL"></a></span></h3></header><h4>Description</h4><p>Specifies the URL of the customized error page. The server will forward the request to this URL when the corresponding HTTP status code has returned. If this URL refers to a non-existing resource, the built-in error page will be used. The URL can be a static file, a dynamically generated page, or a page on another web site (a URL starting with "http(s)://"). When referring to a page on another web site, the client will receive a redirect status code instead of the original status code.</p> <h4>Syntax</h4><p>URL</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="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="suffix"><h3>Suffixes<span class="ls-permlink"><a href="#suffix"></a></span></h3></header><h4>Description</h4><p>Specifies the script file suffixes that will be handled by this script handler. Suffixes must be unique.</p> <h4>Syntax</h4><p>Comma delimited list with period "." character prohibited.</p> <h4>Tips</h4><p><span class="ls-badge ls-badge--info">Information</span> The server will automatically add a special MIME type ("application/x-httpd-[suffix]") for the first suffix in the list. For example, MIME type "application/x-httpd-php53" will be added for suffix "php53". Suffixes after the first need to be set up in the <span class="tagl"><a href="#mime">MIME Settings</a></span> settings.<br/> Though we list suffixes in this field, the script handlers use MIME types, not suffixes, to decide which scripts to handle.<br/> <span class="ls-badge ls-badge--performance">Performance</span><span class="ls-badge ls-badge--security">Security</span> Only specify the suffixes you really need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><header class="ls-helpitem__header" id="shType"><h3>Handler Type<span class="ls-permlink"><a href="#shType"></a></span></h3></header><h4>Description</h4><p>Specifies the type of external application that processes these script files. Available types are: <span class="val">LSAPI app</span>, <span class="val">Web Server (Proxy)</span>, <span class="val">Fast CGI</span>, <span class="val">SCGI</span>, <span class="val">CGI</span>, <span class="val">Load balancer</span>, <span class="val">Servlet Engine</span>, <span class="val">uWSGI</span>, or <span class="val">Module Handler</span>. Except for <span class="val">CGI</span> and <span class="val">Module Handler</span> handler types, <span class="tagl"><a href="#shHandlerName">Handler Name</a></span> must also be set to a previously defined external application in the <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> section.</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="shHandlerName"><h3>Handler Name<span class="ls-permlink"><a href="#shHandlerName"></a></span></h3></header><h4>Description</h4><p>Specifies the name of the external application that processes the script files when the handler type is LSAPI app, Web Server (Proxy), Fast CGI, SCGI, Load balancer, Servlet Engine, or uWSGI.</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="phpIniOverride"><h3>php.ini Override<span class="ls-permlink"><a href="#phpIniOverride"></a></span></h3></header><h4>Description</h4><p>Used to overwrite php.ini settings in the current context (Virtual Host level or Context level).<br/><br/> Supported directives are:<br/> php_value<br/> php_flag<br/> php_admin_value<br/> php_admin_flag<br/><br/> All other lines/directives will be ignored.</p> <h4>Syntax</h4><p>Override syntax is similar to Apache, a newline separated list of directives and their values with each directive being prepended by php_value, php_flag, php_admin_value, or php_admin_flag appropriately.</p> <h4>Example</h4><div class="ls-example">php_value include_path ".:/usr/local/lib/php"<br/> php_admin_flag engine on<br/> php_admin_value open_basedir "/home"</div></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>