| Current File : /home/mmdealscpanel/yummmdeals.com/docs.tar |
license.html 0000644 00000032213 15055121352 0007054 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - EULA - Enterprise Edition</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - EULA - Enterprise Edition." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><span class="current"><a href="license.html">License Enterprise</a></span></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev"> </div><div class="center"><a href="index.html">Home</a></div><div class="next"><a href="intro.html">Introduction</a> »</div></div>
<section class="ls-eula">
<h1>End-User License Agreement for LiteSpeed Software</h1>
<h3>IMPORTANT READ CAREFULLY</h3>
<p>
This End-User License Agreement ("EULA") is a legal agreement between
"You", the end user (either an individual or a single entity) and
LiteSpeed Technologies Inc., a company registered in New Jersey, United
States ("LITESPEED"), for a software product ("SOFTWARE PRODUCT").
</p>
<p>
YOU MUST READ THE TERMS BELOW BEFORE DOWNLOADING, INSTALLING, OR
OTHERWISE USING THE SOFTWARE PRODUCT. BY DOWNLOADING, INSTALLING, OR
USING THE SOFTWARE PRODUCT YOU AGREE TO BE AND WILL BE BOUND BY THE TERMS
OF THIS EULA. IF YOU DO NOT AGREE TO THE TERMS OF THIS EULA, DO NOT
DOWNLOAD, INSTALL, OR USE THE SOFTWARE PRODUCT.
</p>
<h4>1. LICENSE TO USE.</h4>
<p>
In consideration of your agreement to comply with the terms and
conditions of this EULA, LITESPEED hereby grants you a non-exclusive and
nontransferable license to use the SOFTWARE PRODUCT and documentation on
a computer for which you have paid the corresponding fee. You may not use
the SOFTWARE PRODUCT for any illegal activity.
</p>
<p>
1(a) Evaluation Use. Users are granted a trial license to use the
SOFTWARE PRODUCT for evaluation and trial purposed only for a period not
to exceed thirty (30) days. When the trial license expires, users must
either register (purchase a license for continued use) or cease using the
SOFTWARE PRODUCT and remove it from their computer.
</p>
<p>
1(b) Permanent Use. Users are granted a permanent license to use the
SOFTWARE PRODUCT after registration and payment of licensing fees.
Certain hardware information for the computer that the software is
running on is collected in order to generate the license.
</p>
<p
License registration includes 1 month of Email Support and 1 year of
Upgrades. After 1 year, registered users may continue using their current
version. Additional Support and Upgrade services can be purchased
separately by registered users.
</p>
<p>
1(c) This section is applicable to both section 1(a) and 1(b). A single
license may only be used with one copy of the SOFTWARE PRODUCT. A license
for the SOFTWARE PRODUCT may not be shared among multiple copies of the
SOFTWARE PRODUCT running on a same computer or used concurrently on
different computers. You may access the SOFTWARE PRODUCT through a
network by multiple remote computers. If You need another copy of the
SOFTWARE PRODUCT, you must obtain another license.
</p>
<h4>2. COPYRIGHT AND RESTRICTIONS.</h4>
<p>
The SOFTWARE PRODUCT and the associated intellectual property are
protected by copyright laws and international treaty provisions. Title to
the SOFTWARE PRODUCT and all associated intellectual property rights are
retained by LITESPEED. Unauthorized copying or use of the SOFTWARE
PRODUCT, including any portion of the SOFTWARE PRODUCT that has been
modified, merged, or included with other software, is expressly
forbidden. Unless prohibited by applicable law, you may not modify,
decompile, or reverse engineer the SOFTWARE PRODUCT.
</p>
<h4>3. LIMITED WARRANTY/LIMITATIONS ON LIABILITY.</h4>
<p>
3.1 Limited Warranty. With respect to the SOFTWARE PRODUCT licensed under
Section 1(b) (i.e. permanent license), LITESPEED warrants you and for
your benefit only that (a) the SOFTWARE PRODUCT will perform
substantially in accordance with the accompanying written materials for
a period of thirty (30) days from the date of purchase, and (b) any
Support Services provided by LITESPEED shall be substantially as
described and LITESPEED support staff will make commercially reasonable
efforts to solve any problem issues. If, during this time period, the
SOFTWARE PRODUCT does not perform as warranted, LITESPEED's entire
liability and your exclusive remedy shall be, at LITESPEED's option, upon
presentation of a copy of Your receipt, either (a) return of the price
paid, if any, or (b) repair or replacement of the SOFTWARE PRODUCT that
does not meet this Limited Warranty. This Limited Warranty is void if
failure of the SOFTWARE PRODUCT has resulted from accident, abuse, or
misapplication.
</p>
<p>
3.2 No Other Warranties. EXCEPT AS PROVIDED IN SECTION 3.1, THIS SOFTWARE
PRODUCT IS PROVIDED "AS-IS"; LITESPEED MAKES NO OTHER REPRESENTATIONS OR
WARRANTIES, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION,
WARRANTIES THAT THE COVERED CODE IS FREE OF DEFECTS, MERCHANTABLE, OR FIT
FOR A PARTICULAR PURPOSE.
</p>
<p>
3.3 Software Changes. LITESPEED reserves the right at any time not to
release or to discontinue release of any SOFTWARE PRODUCTS and to alter
prices, features, specifications, licensing terms, release dates, general
availability, or other characteristics of the SOFTWARE PRODUCT. LITESPEED
has no obligation to notify You of any changes of the SOFTWARE PRODUCT or
any other products or programs.
</p>
<h4>4. LIMITATION OF LIABILITY.</h4>
<p>
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL
LITESPEED BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR
CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, LOSS OF
PROFITS OR DATA, BUSINESS INTERRUPTION, OR ANY OTHER TANGIBLE OR
INTANGIBLE PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE
THE SOFTWARE PRODUCT OR THE PROVISION OF OR FAILURE TO PROVIDE SUPPORT
SERVICES, EVEN IF LITESPEED HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES. LITESPEED IS NOT LIABLE FOR THE CONTENT OF ANY WEB SITES POWERED
WITH OUR SOFTWARE.
</p>
<h4>5. DATA PROTECTION AND GDPR COMPLIANCE.</h4>
<p>
LITESPEED agrees to deal with personal data relevant to your end-users in accordance
with applicable data protection laws and regulations and the following: (a) with respect to
personal data provided in connection with sales and marketing activities or use of
LITESPEED websites, the LiteSpeed Privacy Policy at
<a href="https://www.litespeedtech.com/company/privacy-policy">
https://www.litespeedtech.com/company/privacy-policy
</a>;
and (b) with respect to any personal information of European Union residents processed
in connection with the SOFTWARE PRODUCT, the GDPR Statement included within the
aforementioned Privacy Policy. You agree to provide any notices and obtain any consent
necessary for LITESPEED to access and process personal and other data as specified
in this Agreement. The Privacy Policy, and the GDPR Statement are incorporated herein
by reference.
</p>
<h4>6. TERMINATION.</h4>
<p>
This EULA shall be effective from the date You download, install or
otherwise use the SOFTWARE PRODUCT. This EULA will terminate immediately
without notice from LITESPEED if you fail to comply with any provision
of this EULA. Upon Termination, you must destroy all copies of the
SOFTWARE PRODUCT. You may terminate this EULA at any time by destroying
all copies of the SOFTWARE PRODUCT.
</p>
<h4>7. SEVERABILITY.</h4>
<p>
If any provision of this EULA is held unenforceable, this EULA shall
remain in effect with the provision reformed to the extent necessary to
make it enforceable, unless to do so would frustrate the intent of the
parties, in which case the EULA will immediately terminate.
</p>
<h4>8. GOVERNING LAW.</h4>
<p>
This EULA shall be governed and be construed by the laws of state of New
Jersey and controlling U.S. federal law.
</p>
<h4>9. EXPORT RESTRICTIONS.</h4>
<p>
The SOFTWARE PRODUCT may be subject to U.S. export laws or regulations
and/or export or import regulations in other countries. Each party shall
comply fully with all such laws and regulations to the extent applicable
and further acknowledges its responsibility to obtain such licenses to
export or import as may be required.
</p>
<h4>10. U.S. GOVERNMENT.</h4>
<p>
If any SOFTWARE PRODUCT is being acquired by or on behalf of the U.S.
Government or by a U.S. Government prime contractor or subcontractor (at
any tier), then the Government's rights in SOFTWARE PRODUCT and
accompanying documentation shall be only as set forth in this EULA.
</p>
</section></article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Listeners_General_Help.html 0000644 00000030414 15055121352 0012010 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Listeners General</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Listeners General." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</a></li>
<li><span class="current"><a href="Listeners_General_Help.html">Listener General</a></span></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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><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_SSL_Help.html">Listeners SSL</a> »</div></div>
<h1>Listeners General</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Address Settings</header><p>
<a href="#listenerName">Listener Name</a> | <a href="#listenerIP">IP Address</a> | <a href="#listenerPort">Port</a> | <a href="#listenerBinding">Binding</a> | <a href="#reusePort">Enable REUSEPORT</a> | <a href="#listenerSecure">Secure</a></p></section>
<section class="toc-row"><header><a href="#virtualHostMapping">Virtual Host Mappings</a></header><p>
<a href="#virtualHostName">Virtual Host</a> | <a href="#domainName">Domains</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="listenerName"><h3>Listener Name<span class="ls-permlink"><a href="#listenerName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this listener.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerIP"><h3>IP Address<span class="ls-permlink"><a href="#listenerIP"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the IP of this listener. All available IP addresses are listed. IPv6 addresses are enclosed in "[ ]".<br/><br/> To listen on all IPv4 IP addresses, select <span class="val">ANY</span>. To listen on all IPv6 IP addresses, select <span class="val">[ANY] IPv6</span>. If <span class="val">No</span> is selected for setting <span class="tagl"><a href="#bindIPv6Only">Bind IPv6 Only</a></span>, selecting <span class="val">[ANY] IPv6</span> will listen on IPv4 addresses as well.<br/><br/> By default, LiteSpeed uses separate listeners for IPv4 and IPv6 addresses. Should the need to serve both IPv4 and IPv6 arise, separate listeners should be created for each.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If your machine has multiple IPs on different sub-networks, you can select a specific IP to only allow traffic from the corresponding sub-network.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerPort"><h3>Port<span class="ls-permlink"><a href="#listenerPort"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the TCP port of the listener. Only the super user ("root") can use ports lower than <span class="val">1024</span>. Port <span class="val">80</span> is the default HTTP port. Port <span class="val">443</span> is the default HTTPS port.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerBinding"><h3>Binding<span class="ls-permlink"><a href="#listenerBinding"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies which lshttpd child process the listener is assigned to. Enterprise Edition spawns multiple child processes to take advantage of the multiple CPUs in a SMP system. Different child processes can be used to handle requests to different listeners by manually associating a listener with a process. By default, a listener is assigned to all child processes.</p> <h4>Syntax</h4><p>Select from checkbox</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="reusePort"><h3>Enable REUSEPORT<span class="ls-permlink"><a href="#reusePort"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Use SO_REUSEPORT socket option to distribute incoming traffic to multiple workers. This setting is only effective for multi-worker licenses. When enabled, all workers are automatically bound to this listener and "Binding" configuration is ignored.<br/><br/> Default value: On</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerSecure"><h3>Secure<span class="ls-permlink"><a href="#listenerSecure"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether this is a secure (SSL) listener. For secure listeners, additional SSL settings need to be set properly.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="virtualHostMapping"><h3>Virtual Host Mappings<span class="ls-permlink"><a href="#virtualHostMapping"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the relationship between the listener and virtual hosts. Listeners and virtual hosts are associated by domain names. An HTTP request will be routed to a virtual host with a matching domain name. One listener can map to multiple virtual hosts for different domain names. One virtual host can also be mapped from different listeners. One listener can allow one catchall virtual host with the domain name value "*". When there is no explicitly matched domain name in the listener's mapping, the listener will forward the request to that catchall virtual host.</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Only add necessary mappings. If the listener is mapped to only one virtual host, then only set up a catchall mapping "*".</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="virtualHostName"><h3>Virtual Host<span class="ls-permlink"><a href="#virtualHostName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of a virtual host.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="domainName"><h3>Domains<span class="ls-permlink"><a href="#domainName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the mapping domain names. Domain names are case insensitive and the leading "www." will be removed. The wildcard characters "*" and "?" are allowed. "?" only represents one character. "*" represents any numbers of characters. Duplicated domain names are not allowed.</p> <h4>Syntax</h4><p>Comma-separated list.</p> <h4>Example</h4><div class="ls-example">www?.example.com<br/> "*.mydomain.com" will match all subdomains of mydomain.com.<br/> "*" by itself is the catchall domain and will match any unmatched domain names.</div><h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If a listener is dedicated to one virtual host, always use <span class="val">*</span> for the domain name to avoid unnecessary checking. Domain names with wildcard characters (other than the catchall domain) should be avoided whenever possible.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
ServTuning_Help.html 0000644 00000157502 15055121352 0010517 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Server Tuning</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Server Tuning." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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><span class="current"><a href="ServTuning_Help.html">Server Tuning</a></span></li>
<li><a href="ServSecurity_Help.html">Server Security</a></li>
<li><a href="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="ServLog_Help.html">Server Log</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="ServSecurity_Help.html">Server Security</a> »</div></div>
<h1>Server Tuning</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>General</header><p>
<a href="#ramDiskPath">RAM Disk Path</a> | <a href="#shmDefaultDir">Default SHM Directory</a> | <a href="#bindIPv6Only">Bind IPv6 Only</a> | <a href="#reverseDnsLookup">Reverse DNS Lookup</a> | <a href="#verifyGoogleBot">Verify Google Bot</a> | <a href="#forceSecureCookie">Secure Cookie Control</a> | <a href="#proxyProtocol">PROXY protocol</a></p></section>
<section class="toc-row"><header>Connection</header><p>
<a href="#maxConnections">Max Connections</a> | <a href="#maxSSLConnections">Max SSL Connections</a> | <a href="#connTimeout">Connection Timeout (secs)</a> | <a href="#maxKeepAliveReq">Max Keep-Alive Requests</a> | <a href="#keepAliveTimeout">Keep-Alive Timeout (secs)</a> | <a href="#sndBufSize">Send Buffer Size (bytes)</a> | <a href="#rcvBufSize">Receive Buffer Size (bytes)</a></p></section>
<section class="toc-row"><header>Request/Response</header><p>
<a href="#maxReqURLLen">Max Request URL Length (bytes)</a> | <a href="#maxReqHeaderSize">Max Request Header Size (bytes)</a> | <a href="#maxReqBodySize">Max Request Body Size (bytes)</a> | <a href="#maxDynRespHeaderSize">Max Dynamic Response Header Size (bytes)</a> | <a href="#maxDynRespSize">Max Dynamic Response Body Size (bytes)</a></p></section>
<section class="toc-row"><header>Static File Delivery Optimization</header><p>
<a href="#maxCachedFileSize">Max Cached Small File Size (bytes)</a> | <a href="#totalInMemCacheSize">Total Small File Cache Size (bytes)</a> | <a href="#maxMMapFileSize">Max MMAP File Size (bytes)</a> | <a href="#totalMMapCacheSize">Total MMAP Cache Size (bytes)</a> | <a href="#useSendfile">Use sendfile()</a> | <a href="#useAIO">Use AIO</a> | <a href="#AIOBlockSize">AIO Block Size</a> | <a href="#fileETag">File ETag</a></p></section>
<section class="toc-row"><header>GZIP/Brotli Compression</header><p>
<a href="#enableGzipCompress">Enable Compression</a> | <a href="#compressibleTypes">Compressible Types</a> | <a href="#enableDynGzipCompress">Enable GZIP Dynamic Compression</a> | <a href="#gzipCompressLevel">GZIP Compression Level (Dynamic Content)</a> | <a href="#enableBrCompress">Brotli Compression Level (Dynamic Content)</a> | <a href="#gzipAutoUpdateStatic">Auto Update Static File</a> | <a href="#gzipStaticCompressLevel">GZIP Compression Level (Static File)</a> | <a href="#brStaticCompressLevel">Brotli Compression Level (Static File)</a> | <a href="#gzipCacheDir">Static Cache Directory</a> | <a href="#gzipMaxFileSize">Max Static File Size (bytes)</a> | <a href="#gzipMinFileSize">Min Static File Size (bytes)</a></p></section>
<section class="toc-row"><header>SSL Global Settings</header><p>
<a href="#sslDefaultCiphers">Default Cipher Suite</a> | <a href="#sslStrongDhKey">SSL Strong DH Key</a> | <a href="#sslEnableMultiCerts">Enable Multiple SSL Certificates</a> | <a href="#sslCertCompress">Enable Certificate Compression</a> | <a href="#sslHsOffload">Enable Handshake Offload</a> | <a href="#sslSessionCache">Enable Session Cache</a> | <a href="#sslSessionCacheSize">Session Cache Size (bytes)</a> | <a href="#sslSessionCacheTimeout">Session Cache Timeout (secs)</a> | <a href="#sslSessionTickets">Enable Session Tickets</a> | <a href="#sslSessionTicketLifetime">SSL Session Ticket Lifetime (secs)</a> | <a href="#sslSessionTicketKeyFile">SSL Session Ticket Key File</a> | <a href="#sslOcspProxy">OCSP Proxy</a> | <a href="#sslStrictSni">Strict SNI Certificate</a></p></section>
<section class="toc-row"><header>HTTP3/QUIC</header><p>
<a href="#quicEnable">Enable HTTP3/QUIC</a> | <a href="#quicShmDir">QUIC SHM Directory</a> | <a href="#quicVersions">HTTP3/QUIC Versions</a> | <a href="#quicCongestionCtrl">Congestion Control</a> | <a href="#quicCfcw">Connection Flow Control Window</a> | <a href="#quicMaxCfcw">Max Connection Flow Control Window</a> | <a href="#quicSfcw">Stream Flow Control Window</a> | <a href="#quicMaxSfcw">Max Stream Flow Control Window</a> | <a href="#quicMaxStreams">Max Concurrent Streams Per Connection</a> | <a href="#quicHandshakeTimeout">Handshake Timeout</a> | <a href="#quicIdleTimeout">Idle Timeout</a> | <a href="#quicEnableDPLPMTUD">Enable DPLPMTUD</a> | <a href="#quicBasePLPMTU">PLPMTU Base Value</a> | <a href="#quicMaxPLPMTU">PLPMTU Max Value</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="ramDiskPath"><h3>RAM Disk Path<span class="ls-permlink"><a href="#ramDiskPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Setting the RAM Disk Path allows you to designate the location of a RAM disk. A RAM disk is a world-writable directory stored in memory. A server with excess RAM can reduce disk I/O by serving content from this RAM disk. Accessing content from RAM is much faster than reading data from the disk. LSWS will use this RAM disk to optimize performance when there is enough memory available.<br/><br/> (The RAM disk must be designated in your OS setup before it can be used by the web server. Many Linux distributions assign /dev/shm as a RAM disk by default, but these settings depend on your OS.)</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="shmDefaultDir"><h3>Default SHM Directory<span class="ls-permlink"><a href="#shmDefaultDir"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Changes shared memory's default directory to the specified path. If the directory does not exist, it will be created. All SHM data will be stored in this directory unless otherwise specified.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="bindIPv6Only"><h3>Bind IPv6 Only<span class="ls-permlink"><a href="#bindIPv6Only"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Only bind IPv6 for IPv6 wildcard IP addresses. When set to "Yes", IPv4 IP addresses will not be bound and will need their own listeners.<br/><br/> Default value: Yes</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="reverseDnsLookup"><h3>Reverse DNS Lookup<span class="ls-permlink"><a href="#reverseDnsLookup"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Perform an IP -> Domain Name lookup for each client. This can be used in access logging.<br/><br/> Default value: No</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="verifyGoogleBot"><h3>Verify Google Bot<span class="ls-permlink"><a href="#verifyGoogleBot"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Perform a PTR lookup to ensure that the reverse DNS of an IP matches Google's crawler information and bypass reCAPTCHA verification if so. Bad Google bot IPs are logged.<br/><br/> Default value: No</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="forceSecureCookie"><h3>Secure Cookie Control<span class="ls-permlink"><a href="#forceSecureCookie"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Control whether to send cookies with the flag "secure", attribute "SameSite=Strict", and attribute "SameSite=Lax".<br/><br/> If both "SameSite=Strict" and "SameSite=Lax" are selected, "SameSite=Strict" will be used.<br/><br/> Default value: "secure"</p> <h4>Syntax</h4><p>Select from checkbox</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="proxyProtocol"><h3>PROXY protocol<span class="ls-permlink"><a href="#proxyProtocol"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>List of IPs/subnets for front-end proxies that communicate with this server using PROXY protocol. Once set, the server will use PROXY protocol for incoming connections from listed IPs/subnets or fall back to a regular connection if PROXY protocol is unavailable.<br/><br/> Applies to HTTP, HTTPS, HTTP2, and websocket connections.</p> <h4>Syntax</h4><p>Comma delimited list of IP addresses or sub-networks.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConnections"><h3>Max Connections<span class="ls-permlink"><a href="#maxConnections"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that the server can accept. This includes both plain TCP connections and SSL connections. This setting should not be set to exceed the hard limit set by the server software edition or license: <span class="val">500</span> for VPS license, <span class="val">800</span> for Ultra VPS license. Once the maximum concurrent connections limit is reached, the server will close Keep-Alive connections when they complete active requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> When the server is started by "root" user, the server will try to adjust the per-process file descriptor limits automatically, however, if this fails, you may need to increase this limit manually.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxSSLConnections"><h3>Max SSL Connections<span class="ls-permlink"><a href="#maxSSLConnections"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent SSL connections the server will accept. Since total concurrent SSL and non-SSL connections cannot exceed the limit specified by <span class="tagl"><a href="#maxConnections">Max Connections</a></span>, the actual number of concurrent SSL connections allowed must be lower than this limit.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="connTimeout"><h3>Connection Timeout (secs)<span class="ls-permlink"><a href="#connTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum connection idle time allowed during processing one request. The connection will be closed if it has been idle, i.e. no I/O activity, for this period of time.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Set this as low as you can to help recover dead connections during a potential DoS attack.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#keepAliveTimeout">Keep-Alive Timeout (secs)</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxKeepAliveReq"><h3>Max Keep-Alive Requests<span class="ls-permlink"><a href="#maxKeepAliveReq"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of requests that can be served through a keep-alive (persistent) session. The connection will be closed once this limit is reached. You can set this limit for each virtual host as well.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Set this to a reasonably high value. A value of "1" or "0" will disable keep-alive.</p> <h4>See Also</h4><p class="ls-text-small">Virtual Host <span class="tagl"><a href="VirtualHosts_Help.html#vhMaxKeepAliveReq">Max Keep-Alive Requests</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="keepAliveTimeout"><h3>Keep-Alive Timeout (secs)<span class="ls-permlink"><a href="#keepAliveTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum idle time between requests from a keep-alive connection. If no new request is received during this period of time, the connection will be closed. This setting only applies to HTTP/1.1 connections. HTTP/2 connections have long keep-alive timeouts by design and are not affected by this setting.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span><span title="Performance" class="ls-icon-performance"></span> We recommend that you set this value just long enough to wait for subsequent requests from a client when there are more assets referenced by a single page that need to be loaded. Do not set this too long hoping that the next page will be served over the keep-alive connection. Keeping many idle keep-alive connections is a waste of server resources and could be taken advantage of by (D)DoS attacks. <span class="val">2-5</span> seconds is a reasonable range for most applications. LiteSpeed is highly efficient in a non-keep-alive environment.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sndBufSize"><h3>Send Buffer Size (bytes)<span class="ls-permlink"><a href="#sndBufSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The sending buffer size of each TCP socket. <span class="val">512K</span> is the maximum allowed buffer size.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> It is recommended to leave this value as "Not Set" or set to 0 to use the operating system's default buffer size.<br/> <span title="Performance" class="ls-icon-performance"></span> If your web site serves large static files, increase the send buffer size to improve performance.<br/> <span title="Performance" class="ls-icon-performance"></span> Setting this to a lower value will reduce throughput and memory usage per socket allowing the server to have more concurrent sockets when memory is a bottleneck.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rcvBufSize"><h3>Receive Buffer Size (bytes)<span class="ls-permlink"><a href="#rcvBufSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The receiving buffer size of each TCP socket. <span class="val">512K</span> is the maximum allowed buffer size.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> It is recommended to leave this value as "Not Set" or set to 0 to use the operating system's default buffer size.<br/> <span title="Performance" class="ls-icon-performance"></span> A large receive buffer will increase performance when processing incoming requests with large payloads, i.e. file uploads.<br/> <span title="Performance" class="ls-icon-performance"></span> Setting this to a lower value will reduce throughput and memory usage per socket allowing the server to have more concurrent sockets when memory is a bottleneck.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxReqURLLen"><h3>Max Request URL Length (bytes)<span class="ls-permlink"><a href="#maxReqURLLen"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum size of a request URL. URL is the full text address used to access a server resource including the query string. Hard limit is <span class="val">65530</span> bytes. Values larger than this, such as <span class="val">64K</span> (6 bytes larger), will be treated as if <span class="val">65530</span> was used.<br/><br/> Default value: <span class="val">8192</span> or <span class="val">8K</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span><span title="Performance" class="ls-icon-performance"></span> Set it reasonably low to reduce memory usage and help identify bogus requests and DoS attacks.<br/> 2-3K is big enough for most web sites unless the HTTP GET method is used with large query strings instead of POST.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxReqHeaderSize"><h3>Max Request Header Size (bytes)<span class="ls-permlink"><a href="#maxReqHeaderSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum size of an HTTP request header including request URL. Hard limit is <span class="val">65530</span> bytes. Values larger than this, such as <span class="val">64K</span> (6 bytes larger), will be treated as if <span class="val">65530</span> was used.<br/><br/> Default value: <span class="val">32768</span> or <span class="val">32K</span></p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span><span title="Performance" class="ls-icon-performance"></span> Set it reasonably low to reduce memory usage and help identify bogus requests and DoS attacks.<br/> 4-8K is big enough for most web sites under normal circumstances.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxReqBodySize"><h3>Max Request Body Size (bytes)<span class="ls-permlink"><a href="#maxReqBodySize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum size of an HTTP request body. For a 32Bit OS, <span class="val">2GB</span> is the hard limit. For a 64Bit OS, it is virtually unlimited.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> To help prevent DoS attacks, try to constrain this limit to only what is really needed. Your swapping space must have enough free space to accommodate this limit.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxDynRespHeaderSize"><h3>Max Dynamic Response Header Size (bytes)<span class="ls-permlink"><a href="#maxDynRespHeaderSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum header size of a dynamically generated response. Hard limit is <span class="val">65530</span> bytes. Values larger than this, such as <span class="val">64K</span> (6 bytes larger), will be treated as if <span class="val">65530</span> was used.<br/><br/> Default value: <span class="val">32768</span> or <span class="val">32K</span></p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Set it reasonably low to help recognize bad responses dynamically generated by external applications.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxDynRespSize"><h3>Max Dynamic Response Body Size (bytes)<span class="ls-permlink"><a href="#maxDynRespSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum body size of a dynamically generated response.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Set the limit reasonably low to help identify bad responses. It is not uncommon to malformed scripts to contain an infinite loop which leads to infinity-sized responses.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxCachedFileSize"><h3>Max Cached Small File Size (bytes)<span class="ls-permlink"><a href="#maxCachedFileSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the largest static file that will be cached in a pre-allocated memory buffer. Static files can be served in four different ways: memory buffer cache, memory-mapped cache, plain read/write, and sendfile(). Files whose size is smaller than this setting are served from memory buffer cache. Files whose size is larger than this setting, but smaller than the <span class="tagl"><a href="#maxMMapFileSize">Max MMAP File Size (bytes)</a></span> will be served from memory-mapped cache. Files whose size is larger than the <span class="tagl"><a href="#maxMMapFileSize">Max MMAP File Size (bytes)</a></span> will be served via plain read/write or sendfile(). It is optimal to serve static files smaller than 4K from the memory buffer cache.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="totalInMemCacheSize"><h3>Total Small File Cache Size (bytes)<span class="ls-permlink"><a href="#totalInMemCacheSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the total memory that can be allocated to the buffer cache in order to cache/serve small static files.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxMMapFileSize"><h3>Max MMAP File Size (bytes)<span class="ls-permlink"><a href="#maxMMapFileSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the largest static file that will be memory mapped (MMAP). Static files can be served in four different ways: memory buffer cache, memory-mapped cache, plain read/write, and sendfile(). Files whose size is smaller than the <span class="tagl"><a href="#maxCachedFileSize">Max Cached Small File Size (bytes)</a></span> are served from memory buffer cache. Files whose size is larger than the <span class="tagl"><a href="#maxCachedFileSize">Max Cached Small File Size (bytes)</a></span>, but smaller than the Max MMAP File Size will be served from memory-mapped cache. Files whose size is larger than the Max MMAP File Size will be served via plain read/write or sendfile(). Since the server has a 32bit address space (2GB), it is not recommended to memory map very large files.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="totalMMapCacheSize"><h3>Total MMAP Cache Size (bytes)<span class="ls-permlink"><a href="#totalMMapCacheSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the total memory that can be allocated for memory- mapped cache in order to cache/serve medium sized static files.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="useSendfile"><h3>Use sendfile()<span class="ls-permlink"><a href="#useSendfile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to use the sendfile() system call to serve static files. Static files can be served in four different ways: memory buffer cache, memory-mapped cache, plain read/write, and sendfile(). Files smaller than the <span class="tagl"><a href="#maxCachedFileSize">Max Cached Small File Size (bytes)</a></span> are served from memory buffer cache. Files larger than the <span class="tagl"><a href="#maxCachedFileSize">Max Cached Small File Size (bytes)</a></span> but smaller than the <span class="tagl"><a href="#maxMMapFileSize">Max MMAP File Size (bytes)</a></span> will be served from memory-mapped cache. Files larger than the <span class="tagl"><a href="#maxMMapFileSize">Max MMAP File Size (bytes)</a></span> will be served via plain read/write or sendfile(). Sendfile() is a "zero copy" system call that can greatly reduce CPU utilization when serving very large static files. Sendfile() requires an optimized network card kernel driver and thus may not be suitable for some small-vendor network adapters.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="useAIO"><h3>Use AIO<span class="ls-permlink"><a href="#useAIO"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to use AIO to serve static files. AIO will help if your server has a high I/O wait. For 64bit operation system, there is an option to keep files mapped in process address space to improve AIO performance.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#AIOBlockSize">AIO Block Size</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="AIOBlockSize"><h3>AIO Block Size<span class="ls-permlink"><a href="#AIOBlockSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the sent block size for AIO. This block size multiplied by the total files being processed should be less than the physical memory of the server, otherwise, AIO will not help. If your server has enough memory, you can choose a bigger size.<br/><br/> Default value: <span class="val">1M</span></p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#useAIO">Use AIO</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="fileETag"><h3>File ETag<span class="ls-permlink"><a href="#fileETag"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to use a file's inode, last-modified time, and size attributes to generate the ETag HTTP response header for static files. All three attributes are enabled by default. If you plan to serve the same file out of mirrored servers, you should not include inode; otherwise, the ETag generated for one file will be different on different servers.</p> <h4>Syntax</h4><p>Select from checkbox</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableGzipCompress"><h3>Enable Compression<span class="ls-permlink"><a href="#enableGzipCompress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables GZIP/Brotli compression for both static and dynamic responses.<br/><br/> Default value: Yes</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enable it to save network bandwidth. Text-based responses such as html, css, and javascript files benefit the most and on average can be compressed to half of their original size.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="compressibleTypes"><h3>Compressible Types<span class="ls-permlink"><a href="#compressibleTypes"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what MIME types are allowed to be compressed. Leave this setting unset or enter <span class="val">default</span> to use the server built-in default list which should already cover most mime-types.<br/><br/> Default value: <span class="val">text/*,application/x-javascript,application/javascript,application/xml,image/svg+xml,application/rss+xml, application/json,application/vnd.ms-fontobject,application/x-font,application/x-font-opentype, application/x-font-truetype,application/x-font-ttf,font/eot,font/opentype,font/otf,font/ttf,image/x-icon, image/vnd.microsoft.icon,application/xhtml+xml</span></p> <h4>Syntax</h4><p>MIME type list separated by commas. Wild card "*" and negate sign "!" are allowed, such as text/*, !text/js.</p> <h4>Example</h4><div class="ls-example">If you want to compress text/* but not text/css, you can have a rule like <span class="val">text/*, !text/css</span>. "!" will exclude that MIME type.</div><h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Only allow types that will benefit from GZIP/Brotli compression. Binary files such as gif/png/jpeg images and flash files do not benefit from compression.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableDynGzipCompress"><h3>Enable GZIP Dynamic Compression<span class="ls-permlink"><a href="#enableDynGzipCompress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Controls GZIP compression for dynamically generated responses.<br/><br/> For this setting to have an effect, <span class="tagl"><a href="#enableGzipCompress">Enable Compression</a></span> must be set to <span class="val">Yes</span>.<br/><br/> Default value: Yes</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Compressing dynamic responses increases CPU and memory utilization but saves network bandwidth.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="gzipCompressLevel"><h3>GZIP Compression Level (Dynamic Content)<span class="ls-permlink"><a href="#gzipCompressLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the level of GZIP compression applied to dynamic content. Ranges from <span class="val">1</span> (lowest) to <span class="val">9</span> (highest).<br/><br/> This setting will only take effect when <span class="tagl"><a href="#enableGzipCompress">Enable Compression</a></span> and <span class="tagl"><a href="#enableDynGzipCompress">Enable GZIP Dynamic Compression</a></span> are enabled.<br/><br/> Default value: 6</p> <h4>Syntax</h4><p>Number between 1 and 9.</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Higher compression level will use more memory and CPU cycles. You can set it to a higher level if your machine has additional power. There is not much difference between 6 and 9, except that 9 uses many more CPU cycles.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableBrCompress"><h3>Brotli Compression Level (Dynamic Content)<span class="ls-permlink"><a href="#enableBrCompress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Controls the level of Brotli compression applied to dynamic responses. Ranges from <span class="val">0</span> (OFF) to <span class="val">6</span> (highest).<br/><br/> This setting will only take effect when <span class="tagl"><a href="#enableGzipCompress">Enable Compression</a></span> is enabled.<br/><br/> Default value: 2</p> <h4>Syntax</h4><p>Number between 0 and 6.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="gzipAutoUpdateStatic"><h3>Auto Update Static File<span class="ls-permlink"><a href="#gzipAutoUpdateStatic"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to let the server automatically create/update GZIP/Brotli-compressed versions of compressible static files or not. If set to <span class="val">Yes</span>, when a file with a MIME type listed in <span class="tagl"><a href="#compressibleTypes">Compressible Types</a></span> is requested, the server may create or update the corresponding compressed version of the file depending on the compressed file's timestamp. This compressed file is created under the <span class="tagl"><a href="#gzipCacheDir">Static Cache Directory</a></span>. The filename is based on a MD5 hash of the path of the original file.<br/><br/> Default value: Yes</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="gzipStaticCompressLevel"><h3>GZIP Compression Level (Static File)<span class="ls-permlink"><a href="#gzipStaticCompressLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the level of GZIP compression applied to static files. Ranges from <span class="val">1</span> (lowest) to <span class="val">9</span> (highest).<br/><br/> This setting will only take effect when <span class="tagl"><a href="#enableGzipCompress">Enable Compression</a></span> and <span class="tagl"><a href="#gzipAutoUpdateStatic">Auto Update Static File</a></span> are enabled.<br/><br/> Default value: 6</p> <h4>Syntax</h4><p>Number between 1 and 9.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="brStaticCompressLevel"><h3>Brotli Compression Level (Static File)<span class="ls-permlink"><a href="#brStaticCompressLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the level of Brotli compression applied to static files. Ranges from <span class="val">1</span> (lowest) to <span class="val">11</span> (highest).<br/><br/> This setting will only take effect when <span class="tagl"><a href="#enableGzipCompress">Enable Compression</a></span> and <span class="tagl"><a href="#gzipAutoUpdateStatic">Auto Update Static File</a></span> are enabled.<br/><br/> Default value: 5</p> <h4>Syntax</h4><p>Number between 1 and 11.</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Save network bandwidth. Text-based responses such as html, css, and javascript files benefit the most and on average can be compressed to half of their original size.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="gzipCacheDir"><h3>Static Cache Directory<span class="ls-permlink"><a href="#gzipCacheDir"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the path of the directory used to store compressed files for static content.<br/><br/> Default value: <span class="tagl"><a href="#swappingDir">Swapping Directory</a></span>.</p> <h4>Syntax</h4><p>Directory Path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="gzipMaxFileSize"><h3>Max Static File Size (bytes)<span class="ls-permlink"><a href="#gzipMaxFileSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum size of a static file for which the server will create a compressed file automatically.<br/><br/> Default value: 10M</p> <h4>Syntax</h4><p>Number in bytes not less than 1K.</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> It is not recommended to have the server create/update compressed files for large files. Compressing blocks an entire server process and no further requests can be processed until the compression is completed.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="gzipMinFileSize"><h3>Min Static File Size (bytes)<span class="ls-permlink"><a href="#gzipMinFileSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the minimum size of a static file for which the server will create a corresponding compressed file.<br/><br/> Default value: 200</p> <h4>Syntax</h4><p>Number in bytes not less than 200.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> It is not necessary to compress very small files as the bandwidth saving is negligible.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslDefaultCiphers"><h3>Default Cipher Suite<span class="ls-permlink"><a href="#sslDefaultCiphers"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Default cipher suite for SSL certificates.<br/><br/> Default value: Server Internal Default (Based on current best practices)</p> <h4>Syntax</h4><p>Colon-separated string of cipher specifications.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslStrongDhKey"><h3>SSL Strong DH Key<span class="ls-permlink"><a href="#sslStrongDhKey"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to use 2048 or 1024 bit DH keys for SSL handshakes. If set to "Yes", 2048 bit DH keys will be used for 2048 bit SSL keys and certificates. 1024 bit DH keys will still be used in other situations. Default is "Yes".<br/><br/> Earlier versions of Java do not support DH key size higher than 1024 bits. If Java client compatibility is required, this should be set to "No".</p> <h4>Syntax</h4><p>radio</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslEnableMultiCerts"><h3>Enable Multiple SSL Certificates<span class="ls-permlink"><a href="#sslEnableMultiCerts"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows listeners/vhosts to set multiple SSL certificates. If multiple certificates are enabled, the certificates/keys are expected to follow a naming scheme. If the cert is named server.crt, other possible cert names are server.crt.rsa, server.crt.dsa, server.crt.ecc. If "Not Set", defaults to "No".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslCertCompress"><h3>Enable Certificate Compression<span class="ls-permlink"><a href="#sslCertCompress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Use SSL certificate compression.<br/><br/> Default value: On</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslHsOffload"><h3>Enable Handshake Offload<span class="ls-permlink"><a href="#sslHsOffload"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Offload SSL handshake to a separate thread.<br/><br/> Default value: On</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionCache"><h3>Enable Session Cache<span class="ls-permlink"><a href="#sslSessionCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables session id caching using OpenSSL's default setting. Default value is "No".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionCacheSize"><h3>Session Cache Size (bytes)<span class="ls-permlink"><a href="#sslSessionCacheSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Sets the maximum number of SSL session IDs to store in the cache. Default is 1,000,000.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionCacheTimeout"><h3>Session Cache Timeout (secs)<span class="ls-permlink"><a href="#sslSessionCacheTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>This value determines how long a session ID will be valid within the cache before renegotiation is required. Default is 3,600.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionTickets"><h3>Enable Session Tickets<span class="ls-permlink"><a href="#sslSessionTickets"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables session tickets using OpenSSL's default session ticket setting. Server-level setting must be set to "Yes" for Virtual Host setting to take effect.<br/><br/> Default values:<br/> <b>Server-level:</b> Yes<br/> <b>VH-Level:</b> Yes</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionTicketLifetime"><h3>SSL Session Ticket Lifetime (secs)<span class="ls-permlink"><a href="#sslSessionTicketLifetime"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>This value determines how long a session ticket will be valid before a renegotiation is required. Default is 3,600.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionTicketKeyFile"><h3>SSL Session Ticket Key File<span class="ls-permlink"><a href="#sslSessionTicketKeyFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows the SSL Ticket Key to be created/maintained by an administrator. The file must be 48 bytes long. If this option is left empty, the load balancer will generate and rotate its own set of keys.<br/><br/> IMPORTANT: To maintain forward secrecy, it is strongly recommended to change the key every <b>SSL Session Ticket Lifetime</b> seconds. If this cannot be done, it is recommended to leave this field empty.</p> <h4>Syntax</h4><p>Path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslOcspProxy"><h3>OCSP Proxy<span class="ls-permlink"><a href="#sslOcspProxy"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Socket address used as the proxy server address for OCSP verification. Leave this setting unset If not using a proxy.<br/><br/> Default value: <span class="val">not set</span></p> <h4>Syntax</h4><p>Socket Address</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslStrictSni"><h3>Strict SNI Certificate<span class="ls-permlink"><a href="#sslStrictSni"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to strictly require a dedicated virtual host certificate configuration. When enabled, SSL connections to virtual hosts without a dedicated certificate configuration will fail instead of using a default catch-all certificate.<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"><div><header id="quicEnable"><h3>Enable HTTP3/QUIC<span class="ls-permlink"><a href="#quicEnable"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables the HTTP3/QUIC network protocol server wide. Default value is <span class="val">Yes</span>.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> When this setting is set to <span class="val">Yes</span>, HTTP3/QUIC can still be disabled at the listener level through the <span class="tagl"><a href="Listeners_SSL_Help.html#allowQuic">Open HTTP3/QUIC (UDP) port</a></span> setting, or at the virtual host level through the <span class="tagl"><a href="VHSSL_Help.html#vhEnableQuic">Enable HTTP3/QUIC</a></span> setting.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicShmDir"><h3>QUIC SHM Directory<span class="ls-permlink"><a href="#quicShmDir"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the directory used to save QUIC data to shared memory.<br/><br/> By default, the server's default SHM directory, <span class="val">/dev/shm</span>, will be used.</p> <h4>Syntax</h4><p>Path</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> A RAM based partition, such as <span class="val">/dev/shm</span>, is recommended.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicVersions"><h3>HTTP3/QUIC Versions<span class="ls-permlink"><a href="#quicVersions"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A list of enabled HTTP3/QUIC versions. This setting should only be used to limit HTTP3/QUIC support to the versions listed and is best left blank.</p> <h4>Syntax</h4><p>Comma-separated list</p> <h4>Example</h4><div class="ls-example">h3-29, h3-Q050</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> It is recommended to leave this setting blank to have the the best configuration applied automatically.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicCongestionCtrl"><h3>Congestion Control<span class="ls-permlink"><a href="#quicCongestionCtrl"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The congestion control algorithm used. This can be set manually or left up to the QUIC library in use by selecting the "Default" option.<br/><br/> Default value: Default</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicCfcw"><h3>Connection Flow Control Window<span class="ls-permlink"><a href="#quicCfcw"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The initial size of the buffer allocated for a QUIC connection. Default value is <span class="val">1.5M</span>.</p> <h4>Syntax</h4><p>Number between 64K and 512M</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> A larger window size will use more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicMaxCfcw"><h3>Max Connection Flow Control Window<span class="ls-permlink"><a href="#quicMaxCfcw"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum size that a connection flow control window buffer is allowed to reach due to window auto-tuning.<br/><br/> Default value is <span class="val">0</span>, which means that the value of <span class="tagl"><a href="ServTuning_Help.html#quicCfcw">Connection Flow Control Window</a></span> is used and no auto-tuning is performed.</p> <h4>Syntax</h4><p>0 or a number between 64K and 512M</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> A larger window size will use more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicSfcw"><h3>Stream Flow Control Window<span class="ls-permlink"><a href="#quicSfcw"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The initial amount of data a QUIC connection is willing to receive per stream. Default value is <span class="val">1M</span>.</p> <h4>Syntax</h4><p>Number between 64K and 128M</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> A larger window size will use more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicMaxSfcw"><h3>Max Stream Flow Control Window<span class="ls-permlink"><a href="#quicMaxSfcw"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum size that a stream flow control window is allowed to reach due to window auto-tuning.<br/><br/> Default value is <span class="val">0</span>, which means that the value of <span class="tagl"><a href="ServTuning_Help.html#quicSfcw">Stream Flow Control Window</a></span> is used and no auto-tuning is performed.</p> <h4>Syntax</h4><p>0 or a number between 64K and 128M</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> A larger window size will use more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicMaxStreams"><h3>Max Concurrent Streams Per Connection<span class="ls-permlink"><a href="#quicMaxStreams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The maximum number of concurrent streams allowed per QUIC connection. Default value is <span class="val">100</span>.</p> <h4>Syntax</h4><p>Integer number between 10 and 1000</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicHandshakeTimeout"><h3>Handshake Timeout<span class="ls-permlink"><a href="#quicHandshakeTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The time in seconds a new QUIC connection is given to complete its handshake, after which the connection is aborted. Default value is <span class="val">10</span>.</p> <h4>Syntax</h4><p>Integer number between 1 and 15</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicIdleTimeout"><h3>Idle Timeout<span class="ls-permlink"><a href="#quicIdleTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The time in seconds after which an idle QUIC connection will be closed. Default value is <span class="val">30</span>.</p> <h4>Syntax</h4><p>Integer number between 10 and 30</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicEnableDPLPMTUD"><h3>Enable DPLPMTUD<span class="ls-permlink"><a href="#quicEnableDPLPMTUD"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enable Datagram Packetization Layer Path Maximum Transmission Unit Discovery (DPLPMTUD).<br/><br/> <b> <a href=" https://tools.ietf.org/html/rfc8899 " target="_blank" rel="noopener noreferrer"> Background on DPLPMTUD (RFC 8899) </a> </b><br/><br/> Default value: Yes</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicBasePLPMTU"><h3>PLPMTU Base Value<span class="ls-permlink"><a href="#quicBasePLPMTU"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The maximum value of PLPMTU (maximum packet size without headers) in bytes that QUIC will use by default. Setting this to <span class="val">0</span> will allow QUIC to pick the size.<br/><br/> This setting should be set lower than <span class="tagl"><a href="#quicMaxPLPMTU">PLPMTU Max Value</a></span>.<br/><br/> Default value: 0</p> <h4>Syntax</h4><p>0 or integer number between 1200 and 65527</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="quicMaxPLPMTU"><h3>PLPMTU Max Value<span class="ls-permlink"><a href="#quicMaxPLPMTU"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The PLPMTU (maximum packet size without headers) probe upper limit in bytes. This setting is used to limit the "maximum packet size" in the DPLPMTUD search space. Setting this to <span class="val">0</span> will allow QUIC to pick the size (By default LSQUIC assumes that MTU is 1,500 bytes (Ethernet)).<br/><br/> This setting should be set higher than <span class="tagl"><a href="#quicBasePLPMTU">PLPMTU Base Value</a></span>.<br/> Default value: 0</p> <h4>Syntax</h4><p>0 or integer number between 1200 and 65527</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
FCGI_Context.html 0000644 00000062420 15055121352 0007651 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Fast CGI Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Fast CGI Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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><span class="current"><a href="FCGI_Context.html">Fast CGI Context</a></span></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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Servlet_Context.html">Servlet Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="LSAPI_Context.html">LiteSpeed SAPI Context</a> »</div></div>
<h1>Fast CGI Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#fcgiContext">FastCGI Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#fcgiapp">FastCGI App</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="fcgiContext"><h3>FastCGI Context<span class="ls-permlink"><a href="#fcgiContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>FastCGI applications cannot be used directly. A FastCGI application must be either configured as a script handler or mapped to a URL through FastCGI context. A FastCGI context will associate a URI with a FastCGI application.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="fcgiapp"><h3>FastCGI App<span class="ls-permlink"><a href="#fcgiapp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the FastCGI application. This application must be defined in the <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> section at the server or virtual host level.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
VHAddOns_Help.html 0000644 00000036555 15055121352 0010025 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Add-ons</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Add-ons." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><span class="current"><a href="VHAddOns_Help.html">Add-ons</a></span></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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Context_Help.html">Context</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"> </div></div>
<h1>Add-ons</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Front Page Server Extension</header><p>
<a href="#enableFrontPage">Enable</a> | <a href="#disableAdmin">Disable Admin</a> | <a href="#domainNames">Domain Names</a></p></section>
<section class="toc-row"><header><a href="#awstats">AWStats Integration</a></header><p>
<a href="#updateMode">Update Mode</a> | <a href="#workingDir">Working Directory</a> | <a href="#awstatsURI">AWStats URI</a> | <a href="#siteDomain">Site Domain</a> | <a href="#siteAliases">Site Aliases</a> | <a href="#updateInterval">Update Interval</a> | <a href="#updateOffset">Update Offset</a> | <a href="#securedConn">Secured Connection</a> | <a href="#awstatsRealm">Authentication Realm</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="enableFrontPage"><h3>Enable<span class="ls-permlink"><a href="#enableFrontPage"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable Microsoft FrontPage Server Extensions. When enabled, Microsoft FrontPage can be used to publish web content. A web administration console is available at URL <span class="val">http://your.domain/_vti_bin/_vti_adm/fpadmcgi.exe</span>.<br/><br/> Additional FrontPage Server Extensions packages must be installed in order to make this work properly.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#disableAdmin">Disable Admin</a></span>, <span class="tagl"><a href="#domainNames">Domain Names</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="disableAdmin"><h3>Disable Admin<span class="ls-permlink"><a href="#disableAdmin"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to disable the web administration console for Microsoft FrontPage Server Extensions. The web administration console is available at URL<br/> <span class="val">http://your.domain/_vti_bin/_vti_adm/fpadmcgi.exe</span>.<br/> Additional FrontPage Server Extensions packages must be installed in order to make it work properly.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Disable the administration console when you no longer need to manage users or change configurations.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#enableFrontPage">Enable</a></span>, <span class="tagl"><a href="#domainNames">Domain Names</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="domainNames"><h3>Domain Names<span class="ls-permlink"><a href="#domainNames"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the virtual servers that provide Front Page Server Extensions service. When a web site is assigned to multiple domain names or service ports, FrontPage access is only available to the domain name and port combinations specified in this list. <br/><br/> Additional FrontPage Server Extensions packages must be installed in order to make it work properly.</p> <h4>Syntax</h4><p>Domain_name:port[, ...] The virtual server name is comprised of domain name and port number.</p> <h4>Example</h4><div class="ls-example">For a web site with domain name "www.mydomain.com" accessible via both HTTP and HTTPS connections, the name list should be something like: <blockquote> <span class="val">www.mydomain.com:80, www.mydomain.com:443</span> </blockquote></div><h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#disableAdmin">Disable Admin</a></span>, <span class="tagl"><a href="#enableFrontPage">Enable</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="awstats"><h3>AWStats Integration<span class="ls-permlink"><a href="#awstats"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>AWStats is a popular log analyzer that generates advanced web server statistics. LiteSpeed web server seamlessly integrates AWStats into its WebAdmin console.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="updateMode"><h3>Update Mode<span class="ls-permlink"><a href="#updateMode"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how AWStats statistics are being updated: <ul> <li> <span class="val">Disabled</span>: AWStats is disabled. Statistics will not be updated. </li> <li> <span class="val">Static</span>: Static HTML pages will be created after the statistics have been updated. </li> <li> <span class="val">Dynamic</span>: The statistics will be updated, but static pages will not be created. HTML pages will be generated dynamically by the CGI script awstats.pl.</li> </ul></p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="workingDir"><h3>Working Directory<span class="ls-permlink"><a href="#workingDir"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the "DataDir" parameter in the AWStats configuration file. All results files and AWStats databases will be stored there. This directory should be writable by the owner of the document root of this virtual host. Usually the working directory should be set to under the virtual host root like <span class="val">$VH_ROOT/awstats/</span>.</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"><div><header id="awstatsURI"><h3>AWStats URI<span class="ls-permlink"><a href="#awstatsURI"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the URI where the AWStats results can be accessed in this virtual host.</p> <h4>Syntax</h4><p>uri</p> <h4>Example</h4><div class="ls-example">If this URI is set to <span class="val">/awstats/</span> for the virtual host www.example.com, then the full URL to the AWStats page would be http://www.example.com/awstats/.</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> The URI should be unique on this virtual host. Otherwise, overlapped content will be inaccessible.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="siteDomain"><h3>Site Domain<span class="ls-permlink"><a href="#siteDomain"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the main domain name of this web site. It controls the "SiteDomain" parameter in AWStats's configuration file. It is used by Awstats to generate full URL paths. If not set, the name of this virtual host will be used.</p> <h4>Syntax</h4><p>domain name</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="siteAliases"><h3>Site Aliases<span class="ls-permlink"><a href="#siteAliases"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies all other possible domain names, IP addresses, and host aliases that this virtual host can be accessed with. This value is used to populate the "SiteAliases" parameter in AWStats configuration. It is used to analyze the referrer field in log files and to help AWStats to decide if a referrer URL is a local or external URL. For best performance, use the the minimum number of possible name/address combinations.</p> <h4>Syntax</h4><p>A list of domain names and IP addresses.</p> <h4>Example</h4><div class="ls-example"><span class="val">www.myserver.com localhost 127.0.0.1 REGEX[mydomain\.(net|org)$]</span></div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="updateInterval"><h3>Update Interval<span class="ls-permlink"><a href="#updateInterval"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how often AWstats statistics are updated. Options are <span class="val">daily</span> or <span class="val">hourly</span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="updateOffset"><h3>Update Offset<span class="ls-permlink"><a href="#updateOffset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies when the update should be performed during the <span class="tagl"><a href="#updateInterval">Update Interval</a></span>.</p> <h4>Syntax</h4><p>Number of seconds.</p> <h4>Example</h4><div class="ls-example">Set this to <span class="val">3600</span> to start statistic processing at 1AM for "Daily" update.</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> If many virtual hosts are hosted on one server, it is recommended to spread out the "Update Offset" to avoid multiple AWstats processes running at the same time and server overload. Log processing is a CPU and I/O intensive task.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="securedConn"><h3>Secured Connection<span class="ls-permlink"><a href="#securedConn"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether HTTPS is used to access AWstats statistics.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="awstatsRealm"><h3>Authentication Realm<span class="ls-permlink"><a href="#awstatsRealm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an authorization realm for the statistical results. When specified, only authorized users can view the results.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
config.html 0000644 00000024371 15055121352 0006705 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Configuration</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Configuration." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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>
<span class="current"><a href="config.html">Configuration</a></span>
<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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="security.html">Security</a></div><div class="center"><a href="index.html">Home</a></div><div class="next"><a href="webconsole.html">Web Console</a> »</div></div>
<h1>Configuration</h1>
<section>
<a name="con"></a><h3><b>Concepts</b></h3>
<p>Here are some basic concepts you should know before going into the detail of the configuration.</p>
<a name="vh"></a><h3>Virtual Hosts</h3>
<p>LiteSpeed web server can host multiple web sites (virtual hosts) with one server instance.</p>
<p>Traditionally, virtual hosts are classified into two types: IP-based virtual hosts and
name-based virtual hosts.
IP-based virtual hosts are web sites that have their own unique IP addresses. Name-based
virtual hosts are web sites that are distinguished by their domain name and
thus may share an IP address with other sites. There is no clear
distinction between these two categories in LiteSpeed
Web Server. IP-based virtual hosts are considered just a special kind of
name-based virtual host. Both of them can be easily configured, or even mixed
together.</p>
<p>Unlike other web servers, LiteSpeed Web Server does not have a default web site.
Every web site is configured as a virtual host even if only one web site is hosted.</p>
<a name="l"></a><h3>Listeners</h3>
<p>In LiteSpeed Web Server, a listener is a server socket that listens on a
specific IP address and TCP port. If you imagine the web server as a building, the listeners are
the doors (each with its own IP address and port).
Clients (browsers) have to go through a door (a listener) to submit their requests.</p>
<p>For each listener, an IP address and a port number need to be specified.
IP address can be any valid local IP address, or you can set a wildcard IP
(*) that refers to all available IP addresses on that machine.
A port is an integer between 0 and 65535.
The default port for HTTP is 80 and 443 for HTTPS.
Other ports can be used, though, on UNIX machines, only the super user "root"
has permission to use ports below 1024.</p>
<p>Only one listener is allowed for each IP and port combination.
Thus, if a listener is configured to one port with the wildcard IP address,
you cannot configure another listener to the same port, even if you specify
a particular IP. For example, if there are multiple IP addresses on the web
server machine, and HTTP traffic needs to be allowed on port 8080 for all
IP addresses, this can be configured in two ways: set up one
listener using the wildcard IP (*) and port 8080, or set up multiple
listeners, one for each IP, all listening to port 8080. These two methods
cannot be mixed on a single port.</p>
<p>There are two types of listeners in LiteSpeed Web Server: plain and secure
(SSL). Each secure listener requires a paired SSL private key and SSL certificate.
The private key can be generated with an SSL toolkit like
OpenSSL. The SSL certificate can be self-signed or obtained from
an SSL certificate issuer like VeriSign or Thawte. You can share the same private
key and certificate pair among multiple listeners. </p>
<a name="map"></a><h3>Listener to Virtual Host Mapping</h3>
<p>LiteSpeed's Listener to Virtual Host Mapping provides extra flexibility, allowing you
to:</p>
<ul>
<li>map one listener to one virtual host.</li>
<li>map one listener to different virtual hosts for different domain names.</li>
<li>map multiple listeners to the same virtual host.</li>
<li>map multiple listeners to multiple virtual hosts depending on their domain names.</li>
</ul>
<p>In Listener to Virtual Host Mapping, every listener has a virtual host lookup table
with key-value pairs that specify a domain name (key) for
a particular virtual host (value).</p>
<p>When a browser tries to retrieve a web page from a web server, it first uses a DNS lookup to
find the IP address associated with that domain name. It then sends a request to establish a
TCP connection with the web server on a specific IP and port. If there is a listener assigned
to that IP and port, a connection is established. The browser then sends an HTTP
request, which includes, in the header, the domain name of the web site being accessed.
The web server checks the lookup table associated with that listener for the domain name
in the request. If a match is found, the request is routed to the virtual host for processing.</p>
<p>In order to make a virtual host accessible through a specific listener, you must
make sure that:</p>
<ol>
<li>DNS is configured properly to map the domain name of the web site to the
IP used by that listener. How to configure DNS is beyond the scope of this document.</li>
<li>A mapping to the virtual host for that domain name exists in the listener's
lookup table.</li>
</ol>
<p>A catchall virtual host can be specified for one listener with the wild card domain name
"*". When the server cannot find a matching virtual host, the request will be routed
to the catchall virtual host. If there is no such catchall virtual host configured,
the web server will return error code 404.</p>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Servlet_Context.html 0000644 00000063047 15055121352 0010573 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Servlet Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Servlet Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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><span class="current"><a href="Servlet_Context.html">Servlet Context</a></span></li>
<li><a href="FCGI_Context.html">Fast 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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Java_Web_App_Context.html">Java Web App Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="FCGI_Context.html">Fast CGI Context</a> »</div></div>
<h1>Servlet Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#servletContext">Servlet Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#servletEngine">Servlet Engine</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="servletContext"><h3>Servlet Context<span class="ls-permlink"><a href="#servletContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Servlets can be imported individually through Servlet Contexts. A Servlet Context just specifies the URI for the servlet and the name of the servlet engine. You only need to use this when you do not want to import the whole web application or you want to protect different servlets with different authorization realms. This URI has the same requirements as for a <span class="tagl"><a href="#javaWebAppContext">Java Web App Context</a></span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="servletEngine"><h3>Servlet Engine<span class="ls-permlink"><a href="#servletEngine"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the servlet engine that serves this web application. Servlet engines must be defined in the <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> section at the server or virtual host level.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
VirtualHosts_Help.html 0000644 00000052756 15055121352 0011067 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Virtual Hosts Basic</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Virtual Hosts Basic." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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><span class="current"><a href="VirtualHosts_Help.html">Virtual Host Basic</a></span></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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Templates_Help.html">Virtual Host Templates</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="VHGeneral_Help.html">Virtual Host General</a> »</div></div>
<h1>Virtual Hosts Basic</h1><section class="ls-spacer-small-bottom">This page lists all defined virtual hosts. From here you can add/delete a virtual host or make
changes to an existing one. Before you add a virtual host, make sure the virtual host root directory exists.</section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Base</header><p>
<a href="#vhName">Virtual Host Name</a> | <a href="#vhRoot">Virtual Host Root</a> | <a href="#configFile">Config File</a></p></section>
<section class="toc-row"><header>Connection</header><p>
<a href="#vhMaxKeepAliveReq">Max Keep-Alive Requests</a></p></section>
<section class="toc-row"><header>Security</header><p>
<a href="#allowSymbolLink">Follow Symbolic Link</a> | <a href="#enableScript">Enable Script</a> | <a href="#restrained">Restrained</a> | <a href="#setUidMode">External App Set UID Mode</a> | <a href="#suexecUser">suEXEC User</a> | <a href="#suexecGroup">suEXEC Group</a> | <a href="#chrootMode">External App Chroot Mode</a> | <a href="#chrootPath">External App Chroot Path</a> | <a href="#totalBandwidth">Total Output Bandwidth (KB/sec)</a></p></section>
<section class="toc-row"><header>Virtual Host</header><p>
<a href="#staticReqPerSec">Static Requests/Second</a> | <a href="#dynReqPerSec">Dynamic Requests/Second</a> | <a href="#outBandwidth">Outbound Bandwidth (bytes/sec)</a> | <a href="#inBandwidth">Inbound Bandwidth (bytes/sec)</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="vhName"><h3>Virtual Host Name<span class="ls-permlink"><a href="#vhName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for a virtual host. It is recommended to use the virtual host's domain name as the Virtual Host Name. Virtual Host Name can be referred to using the variable $VH_NAME.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vhRoot"><h3>Virtual Host Root<span class="ls-permlink"><a href="#vhRoot"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the root directory of the virtual host. Note: This is <b>NOT</b> the document root. It is recommended to place all files related to the virtual host (like log files, html files, CGI scripts, etc.) under this directory. Virtual Host Root can be referred to using the variable $VH_ROOT.</p> <h4>Syntax</h4><p>An absolute path or a relative path to $SERVER_ROOT.</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Place different virtual hosts on different hard drives.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="configFile"><h3>Config File<span class="ls-permlink"><a href="#configFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The configuration filename and directory for this virtual host.</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 title="Information" class="ls-icon-info"></span> <span class="val">$SERVER_ROOT/conf/vhosts/$VH_NAME.xml</span> is recommended for easy management.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vhMaxKeepAliveReq"><h3>Max Keep-Alive Requests<span class="ls-permlink"><a href="#vhMaxKeepAliveReq"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum requests that can be served through a keep-alive (persistent) connection. Connections will be closed once this limit is reached. You can specify a different limit for each virtual hosts. This number cannot exceed the server-level <span class="tagl"><a href="ServTuning_Help.html#maxKeepAliveReq">Max Keep-Alive Requests</a></span> limit.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Set to a reasonably high value. A value of "1" or less will disable keep-alive connections.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="ServTuning_Help.html#maxKeepAliveReq">Max Keep-Alive Requests</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowSymbolLink"><h3>Follow Symbolic Link<span class="ls-permlink"><a href="#allowSymbolLink"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to follow symbolic links in this virtual host. <span class="val">IF OWNER MATCH</span> option will follow a symbolic link only if it has the same ownership. This setting overrides the default server-level setting.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span><span title="Security" class="ls-icon-security"></span> For better security, disable this feature. For better performance, enable it.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableScript"><h3>Enable Script<span class="ls-permlink"><a href="#enableScript"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether scripting (non-static pages) is allowed in this virtual host. If disabled, CGI, FastCGI, LSAPI, Servlet engines and other scripting languages will not be allowed in this virtual host. Therefore, if you want to use a script handler, you need to enable it here as well.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="restrained"><h3>Restrained<span class="ls-permlink"><a href="#restrained"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether files beyond this virtual host root($VH_ROOT) can be accessed though this web site. If set to <span class="val">Yes</span>, only files under $VH_ROOT can be accessed and access to symbolic links or context pointing to files or directories beyond $VH_ROOT will be denied. This, however, does not limit the accessibility of CGI scripts. This is useful in the shared hosting environment. <span class="tagl"><a href="#allowSymbolLink">Follow Symbolic Link</a></span> can be set to <span class="val">Yes</span> to allow users to use symbolic links under $VH_ROOT, but not anything beyond $VH_ROOT.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Turn it on in the shared hosting environment.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="setUidMode"><h3>External App Set UID Mode<span class="ls-permlink"><a href="#setUidMode"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how user ID is set for an external application process. Three choices are available: <ul><li><span class="val">Server UID</span>: Set the user/group ID of external application processes to the same as the server's user/group ID.</li> <li><span class="val">CGI File UID</span>: Set the user/group ID of external CGI processes based on the user/group ID of the executable. This option only applies to CGI, not FastCGI or LSPHP.</li> <li><span class="val">Doc Root UID</span>: Set the user/group ID of external application processes based on the user/group ID of the document root of the current virtual host.</li> </ul><br/><br/> Default value: <span class="val">Server UID</span></p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> In the shared hosting environment, it is recommended to use the <span class="val">CGI File UID</span> or <span class="val">Doc Root UID</span> modes to prevent files owned by one virtual host from being accessed by the external application scripts of another virtual host.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="suexecUser"><h3>suEXEC User<span class="ls-permlink"><a href="#suexecUser"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>At the current context level, run as this user. If set, this value will override the Virtual Host level <b>ExtApp Set UID Mode</b> setting.<br/><br/> This configuration may be overridden at the External Application level using the <b>Run As User</b> setting.<br/><br/> Default value: Not Set</p> <h4>Syntax</h4><p>Valid user name or uid.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="suexecGroup"><h3>suEXEC Group<span class="ls-permlink"><a href="#suexecGroup"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>At the current context level, run as this group. Either <b>suEXEC User</b> at the Virtual Host level, or <b>Run As User</b> at the External Application level, must be set for <b>suEXEC Group</b> to take effect.<br/><br/> This configuration can be overridden at the External Application level using the <b>Run As Group</b> setting.<br/><br/> Default value: <b>suExec User</b> setting value</p> <h4>Syntax</h4><p>Valid group name or uid</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="chrootMode"><h3>External App Chroot Mode<span class="ls-permlink"><a href="#chrootMode"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies how the root directory is set for an external application process. In order to protect confidential system data files from being accessed by a vulnerable external application script, an alternative root path can be set for the external application process so that files beyond the new root directory become inaccessible. This is referred to as a "chroot jail".<br/><br/> Three choices are available: <ul><li><span class="val">Same as Server</span>: External application processes will be run in the same jail as the server.</li> <li><span class="val">Virtual Host Root</span>: Set chroot jail to the root directory of the virtual host. The external application script will only be able to access files inside the virtual host root. </li> <li><span class="val">Customized Chroot Path</span>: Specify the chroot path <span class="tagl"><a href="#chrootPath">External App Chroot Path</a></span> below. </li> </ul></p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> If used properly, chroot will greatly enhance the security of external application scripts, but you must make sure the external application script is functional in the limited chroot jail environment.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="chrootPath"><h3>External App Chroot Path<span class="ls-permlink"><a href="#chrootPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies a new root directory for the current host's external application scripts when <span class="tagl"><a href="#chrootMode">External App Chroot Mode</a></span> is set to <span class="val">Customized Chroot Path</span>.</p> <h4>Syntax</h4><p>Absolute path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="totalBandwidth"><h3>Total Output Bandwidth (KB/sec)<span class="ls-permlink"><a href="#totalBandwidth"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Sets a limit for the total output bandwidth in KB/s for this virtual host. Once this limit is reached throttling will occur.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="staticReqPerSec"><h3>Static Requests/Second<span class="ls-permlink"><a href="#staticReqPerSec"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of requests to static content coming from a single IP address that can be processed in a single second regardless of the number of connections established.<br/><br/> When this limit is reached, all future requests are tar-pitted until the next second. Request limits for dynamically generated content are independent of this limit. Per-client request limits can be set at server- or virtual host-level. Virtual host-level settings override server-level settings.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#dynReqPerSec">Dynamic Requests/Second</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="dynReqPerSec"><h3>Dynamic Requests/Second<span class="ls-permlink"><a href="#dynReqPerSec"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of requests to dynamically generated content coming from a single IP address that can be processed in each second regardless of the number of connections established. When this limit is reached, all future requests to dynamic content are tar-pitted until the next second.<br/><br/> The request limit for static content is independent of this limit. This per client request limit can be set at server or virtual host level. Virtual host-level settings override server-level settings.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not restrained by this limit.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#staticReqPerSec">Static Requests/Second</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="outBandwidth"><h3>Outbound Bandwidth (bytes/sec)<span class="ls-permlink"><a href="#outBandwidth"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The maximum allowed outgoing throughput to a single IP address, regardless of the number of connections established. The real bandwidth may end up being slightly higher than this setting for efficiency reasons. Bandwidth is allocated in 4KB units. Set to <span class="val">0</span> to disable throttling. Per-client bandwidth limits (bytes/sec) can be set at the server or virtual host level where virtual host level settings override server level settings.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Set the bandwidth in 8KB units for better performance.<br/><br/> <span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#inBandwidth">Inbound Bandwidth (bytes/sec)</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="inBandwidth"><h3>Inbound Bandwidth (bytes/sec)<span class="ls-permlink"><a href="#inBandwidth"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The maximum allowed incoming throughput from a single IP address, regardless of the number of connections established. The real bandwidth may end up being slightly higher than this setting for efficiency reasons. Bandwidth is allocated in 1KB units. Set to <span class="val">0</span> to disable throttling. Per-client bandwidth limits (bytes/sec) can be set at the server or virtual host level where virtual host level settings override server level settings.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#outBandwidth">Outbound Bandwidth (bytes/sec)</a></span></p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
External_LB.html 0000644 00000014736 15055121352 0007603 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Load Balancer</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Load Balancer." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><span class="current"><a href="External_LB.html">Load Balancer</a></span></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="External_PL.html">Piped Logger</a></div><div class="center"><a href="ExtApp_Help.html">External Apps</a></div><div class="next"> </div></div>
<h1>Load Balancer</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Load Balancer</header><p>
<a href="#extAppName">Name</a> | <a href="#extWorkers">Workers</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="extAppName"><h3>Name<span class="ls-permlink"><a href="#extAppName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this external application. You will refer to it by this name when you use it in other parts of the configuration.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extWorkers"><h3>Workers<span class="ls-permlink"><a href="#extWorkers"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>List of worker groups previously defined in the external load balancer.</p> <h4>Syntax</h4><p>A comma-separated list in the form ExternalAppType::ExternalAppName</p> <h4>Example</h4><div class="ls-example">fcgi::localPHP, proxy::backend1</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
External_LSAPI.html 0000644 00000061035 15055121352 0010150 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - LiteSpeed SAPI App</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - LiteSpeed SAPI App." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<li><a href="External_FCGI.html">Fast CGI App</a></li>
<li><a href="External_FCGI_Auth.html">Fast CGI Authorizer</a></li>
<li><span class="current"><a href="External_LSAPI.html">LSAPI App</a></span></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="External_FCGI_Auth.html">Fast CGI Authorizer</a></div><div class="center"><a href="ExtApp_Help.html">External Apps</a></div><div class="next"><a href="External_Servlet.html">Servlet Engine</a> »</div></div>
<h1>LiteSpeed SAPI App</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>LiteSpeed SAPI</header><p>
<a href="#extAppName">Name</a> | <a href="#extAppAddress">Address</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#persistConn">Persistent Connection</a> | <a href="#pcKeepAliveTimeout">Connection Keepalive Timeout</a> | <a href="#respBuffer">Response Buffering</a> | <a href="#autoStart">Start By Server</a> | <a href="#extAppPath">Command</a> | <a href="#backlog">Back Log</a> | <a href="#instances">Instances</a> | <a href="#extUser">Run As User</a> | <a href="#extGroup">Run As Group</a> | <a href="#extUmask">umask</a> | <a href="#runOnStartUp">Run On Start Up</a> | <a href="#extMaxIdleTime">Max Idle Time</a> | <a href="#extAppPriority">Priority</a> | <a href="#memSoftLimit">Memory Soft Limit (bytes)</a> | <a href="#memHardLimit">Memory Hard Limit (bytes)</a> | <a href="#procSoftLimit">Process Soft Limit</a> | <a href="#procHardLimit">Process Hard Limit</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="extAppName"><h3>Name<span class="ls-permlink"><a href="#extAppName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this external application. You will refer to it by this name when you use it in other parts of the configuration.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppAddress"><h3>Address<span class="ls-permlink"><a href="#extAppAddress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique socket address used by the external application. IPv4/IPv6 sockets and Unix Domain Sockets (UDS) are supported. IPv4/IPv6 sockets can be used for communication over the network. UDS can only be used when the external application resides on the same machine as the server.</p> <h4>Syntax</h4><p>IPv4 or IPV6 address:port or UDS://path</p> <h4>Example</h4><div class="ls-example">127.0.0.1:5434<br/> UDS://tmp/lshttpd/php.sock.</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If the external application runs on the same machine, UDS is preferred. If you have to use an IPv4|IPV6 socket, set the IP address to <span class="val">localhost</span> or <span class="val">127.0.0.1</span>, so the external application is inaccessible from other machines.<br/> <span title="Performance" class="ls-icon-performance"></span> Unix Domain Sockets generally provide higher performance than IPv4 sockets.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="initTimeout"><h3>Initial Request Timeout (secs)<span class="ls-permlink"><a href="#initTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds the server will wait for the external application to respond to the first request over a new established connection. If the server does not receive any data from the external application within this timeout limit, it will mark this connection as bad. This helps to identify communication problems with external applications as quickly as possible. If some requests take longer to process, increase this limit to avoid 503 error messages.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="retryTimeout"><h3>Retry Timeout (secs)<span class="ls-permlink"><a href="#retryTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the period of time that the server waits before retrying an external application that had a prior communication problem.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="persistConn"><h3>Persistent Connection<span class="ls-permlink"><a href="#persistConn"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to keep the connection open after a request has been processed. Persistent connections can increase performance, but some FastCGI external applications do not support persistent connections fully. The default is "On".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pcKeepAliveTimeout"><h3>Connection Keepalive Timeout<span class="ls-permlink"><a href="#pcKeepAliveTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds to keep an idle persistent connection open.<br/><br/> When set to "-1", the connection will never timeout. When set to 0 or greater, the connection will be closed after this time in seconds has passed.</p> <h4>Syntax</h4><p>int</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="respBuffer"><h3>Response Buffering<span class="ls-permlink"><a href="#respBuffer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to buffer responses received from external applications. If a "nph-" (Non-Parsed-Header) script is detected, buffering is turned off for responses with full HTTP headers.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoStart"><h3>Start By Server<span class="ls-permlink"><a href="#autoStart"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether you want the web server to start the application automatically. Only FastCGI and LSAPI applications running on the same machine can be started automatically. The IP in the <span class="tagl"><a href="#extAppAddress">Address</a></span> must be a local IP. Starting through the LiteSpeed CGI Daemon instead of a main server process will help reduce system overhead. CGI Daemon Async mode (non-blocking event-driven method) is recommended for servers with high I/O wait.<br/><br/> Default value: Yes (Through CGI Daemon Async)</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPath"><h3>Command<span class="ls-permlink"><a href="#extAppPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the full command line including parameters to execute the external application. Required value if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled. A parameter should be quoted with a double or single quote if the parameter contains space or tab characters.</p> <h4>Syntax</h4><p>Full path to the executable with optional parameters.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#autoStart">Start By Server</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="backlog"><h3>Back Log<span class="ls-permlink"><a href="#backlog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the backlog of the listening socket. Required if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="instances"><h3>Instances<span class="ls-permlink"><a href="#instances"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum instances of the external application the server will create. It is required if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled. Most FastCGI/LSAPI applications can only process one request per process instance and for those types of applications, instances should be set to match the value of <span class="tagl"><a href="#maxConns">Max Connections</a></span>. Some FastCGI/LSAPI applications can spawn multiple child processes to handle multiple requests concurrently. For these types of applications, instances should be set to "1" and environment variables used to control how many child processes the application can spawn.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extUser"><h3>Run As User<span class="ls-permlink"><a href="#extUser"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The external application will run as this specified user name. If not set, Virtual Host level settings will be inherited.<br/><br/> Default value: Not Set</p> <h4>Syntax</h4><p>Valid username.</p> <h4>See Also</h4><p class="ls-text-small">extGroup</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extGroup"><h3>Run As Group<span class="ls-permlink"><a href="#extGroup"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The external application will run as this specified group name. If not set, Virtual Host level settings will be inherited.<br/><br/> Default value: Not Set</p> <h4>Syntax</h4><p>Valid group name.</p> <h4>See Also</h4><p class="ls-text-small">extUser</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extUmask"><h3>umask<span class="ls-permlink"><a href="#extUmask"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Sets default umask for this external application's processes. See <span class="cmd"> man 2 umask </span> for details. The default value taken from the server-level <span class="tagl"><a href="ServSecurity_Help.html#umask">umask</a></span> setting.</p> <h4>Syntax</h4><p>value valid range [000]-[777].</p> <h4>See Also</h4><p class="ls-text-small">CGI <span class="tagl"><a href="ServSecurity_Help.html#umask">umask</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="runOnStartUp"><h3>Run On Start Up<span class="ls-permlink"><a href="#runOnStartUp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to start the external application at server start up. Only applicable to external applications that can manage their own child processes and where <span class="tagl"><a href="#instances">Instances</a></span> value is set to "1".<br/><br/> If enabled, external processes will be created at server startup instead of run-time.<br/><br/> When selecting "Yes (Detached mode)", all detached process can be restarted at the Server level or Virtual Host level by touching the '.lsphp_restart.txt' file under the $SERVER_ROOT/admin/tmp/ or $VH_ROOT/ directory respectively.<br/><br/> Default value: Yes (Detached mode)</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If the configured external process has significant startup overhead, like a Rails app, then this option should be enabled to decrease first page response time.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extMaxIdleTime"><h3>Max Idle Time<span class="ls-permlink"><a href="#extMaxIdleTime"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum idle time before an external application is stopped by the server, freeing idle resources. When set to "-1", the external application will not be stopped by the server unless running in ProcessGroup mode where idle external applications will be stopped after 30 seconds.<br/><br/> Default value: <span class="val">-1{/val}</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> This feature is especially useful in the mass hosting environment where, in order to prevent files owned by one virtual host from being accessed by the external application scripts of another virtual host, many different applications are run at the same time in SetUID mode. Set this value low to prevent these external applications from idling unnecessarily.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPriority"><h3>Priority<span class="ls-permlink"><a href="#extAppPriority"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies priority of the external application process. Value ranges from <span class="val">-20</span> to <span class="val">20</span>. A lower number means a higher priority. An external application process cannot have a higher priority than the web server. If this priority is set to a lower number than the server's, the server's priority will be used for this value.</p> <h4>Syntax</h4><p>int</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#serverPriority">Priority</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memSoftLimit"><h3>Memory Soft Limit (bytes)<span class="ls-permlink"><a href="#memSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the memory consumption limit in bytes for an external application process or an external application started by the server.<br/><br/> The main purpose of this limit is to prevent excessive memory usage because of software bugs or intentional attacks, not to impose a limit on normal usage. Make sure to leave enough head room, otherwise your application may fail and 503 error may be returned. It can be set at the server- level or at an individual external application level. The server-level limit will be used if it is not set at the individual application level.<br/><br/> The operating system's default setting will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application needs more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memHardLimit"><h3>Memory Hard Limit (bytes)<span class="ls-permlink"><a href="#memHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#memSoftLimit">Memory Soft Limit (bytes)</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level.<br/><br/> The operating system's default will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application need more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procSoftLimit"><h3>Process Soft Limit<span class="ls-permlink"><a href="#procSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Limits the total number of processes that can be created on behalf of a user. All existing processes will be counted against this limit, not just new processes to be started.<br/><br/> The limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default setting will be used if this value is 0 or absent at both levels.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> To control how many processes LSWS will make for users in mod_suEXEC mode, use the suEXEC Max Conn setting. PHP scripts can call for forking processes and the number of processes needed for normal functioning can be above the suEXEC Max Conn setting. The main purpose of this limit is as a last line of defense to prevent fork bombs and other attacks caused by PHP processes creating other processes.<br/><br/> Setting this setting too low can severely hurt functionality. The setting will thus be ignored below certain levels.<br/><br/> When <b>Run On Start Up</b> is set to "Yes (Daemon mode)", the actual process limit will be higher than this setting to make sure parent processes are not limited.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procHardLimit"><h3>Process Hard Limit<span class="ls-permlink"><a href="#procHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#procSoftLimit">Process Soft Limit</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default value will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
intro.html 0000644 00000023315 15055121352 0006570 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Introduction</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Introduction." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><span class="current"><a href="intro.html">Introduction</a></span></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="license.html">EULA - Enterprise Edition</a></div><div class="center"><a href="index.html">Home</a></div><div class="next"><a href="install.html">Installation</a> »</div></div>
<h1>Introduction</h1>
<h3>Overview</h3>
<p>
LiteSpeed Web Server is an Apache-interchangeable, high performance, secure, easy-to-use web server. It can handle
thousands of concurrent connections with a small memory footprint. Its security features also make it much less
vulnerable to various attacks.
</p>
<h3>LiteSpeed Exclusive Features</h3>
<ul>
<li>Apache Drop-In Replacement</li>
<li>HTTP/2 Support</li>
<li>QUIC Support</li>
<li>Zero Downtime</li>
<li>Anti-DDoS Advances</li>
<li>Event-Driven Architecture</li>
</ul>
<h3>Features</h3>
<ul>
<li>
<p><strong>HTTP/1.1</strong></p>
<ul>
<li>HTTP/2</li>
<li>HTTP 1.0/1.1 compliant</li>
<li>Scripting Languages: PHP, Perl, Ruby, Python, Java, etc...</li>
<li>Server APIs: LiteSpeed SAPI (LSAPI), CGI, FCGI, AJPv13, Proxy</li>
<li>HTTPS</li>
<li>IPv4 and IPv6</li>
<li>Unlimited IP and name-based virtual hosting</li>
<li>Unlimited concurrent connections</li>
<li>GZIP compression</li>
<li>Support for SPDY/2, 3, and 3.1</li>
<li>WebSocket proxying</li>
<li>Runs on Linux, FreeBSD, MacOSX, Solaris</li>
</ul>
</li>
<li>
<p><strong>Performance & Scalability</strong></p>
<ul>
<li>Event-driven architecture</li>
<li>Hundreds of thousands of concurrent connections</li>
<li>Tiny memory footprint</li>
<li>Sendfile()</li>
<li>Asynchronous I/O support</li>
<li>LiteSpeed's exclusive server API (LSAPI) delivers the best dynamic content performance</li>
<li>Unrivaled PHP suEXEC performance for shared hosting</li>
<li>Three different PHP process modes for different needs and abilities</li>
<li>Static content up to 5x faster than Apache</li>
<li>Dynamic content up to 40x faster than Apache</li>
<li>HTTPS 3x faster than Apache</li>
<li>OCSP stapling</li>
<li>Built-in page caching</li>
<li>Turbocharge Magento and other web applications with ESI support</li>
<li>Advanced .htaccess caching removes performance bottlenecks associated with .htaccess use in Apache</li>
<li>CloudLinux LVE compatibility</li>
<li>Increases scalability of web applications</li>
<li>
Separation of server and web applications allows for buffering of requests and responses, leading to better
handling of multiple connections
</li>
<li>Just in time configuration cuts restart time</li>
<li>CPU affinity allows for greater use of CPU cache</li>
</ul>
</li>
<li>
<p><strong>Apache Compatibility</strong></p>
<ul>
<li>Reads Apache's configuration files directly</li>
<li>Drop-in Apache replacement for cPanel, Plesk, DirectAdmin, Interworx, etc.</li>
<li>Full .htaccess support</li>
<li>Compatible with Apache core modules</li>
</ul>
</li>
<li>
<p><strong>Security</strong></p>
<ul>
<li>Built-in anti-DDoS connection and bandwidth throttling</li>
<li>mod_security compatibility</li>
<li>Compatibility with Atomic Secured Linux and Atomicorp Realtime ModSecurity Rules</li>
<li>Anti SSL BEAST and renegotiation attack capabilities</li>
<li>Strict HTTP request validation</li>
<li>Denies buffer-overrun attempts</li>
<li>PHP/Ruby/CGI/FCGI/LSAPI suEXEC</li>
<li>CloudLinux CageFS compatibility</li>
<li>External application and full server chroot ability</li>
</ul>
</li>
<li>
<p><strong>High Availability</strong></p>
<ul>
<li>Apply changes with zero downtime</li>
<li>Zero downtime server software upgrade</li>
<li>Recovers from service failure instantly</li>
</ul>
</li>
<li>
<p><strong>Ease of Use</strong></p>
<ul>
<li>Control panel plugins (cPanel, DirectAdmin, and Plesk)</li>
<li>Officially supported by cPanel</li>
<li>Intuitive WebAdmin console GUI</li>
<li>Virtual host templates for easy configuration</li>
<li>Real-time service monitoring</li>
</ul>
</li>
<li>
<p><strong>Advanced Features</strong></p>
<ul>
<li>Easily run multiple versions of PHP on one server</li>
<li>MS FrontPage Server Extensions</li>
<li>Geo-IP lookup</li>
<li>Stream logs to external logger</li>
<li>Custom log formatting</li>
<li>Backend load balancing</li>
<li>mp4/flv streaming</li>
</ul>
</li>
</ul></article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
External_FCGI.html 0000644 00000060713 15055121352 0010012 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Fast CGI App</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Fast CGI App." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<li><span class="current"><a href="External_FCGI.html">Fast CGI App</a></span></li>
<li><a href="External_FCGI_Auth.html">Fast CGI Authorizer</a></li>
<li><a href="External_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev"> </div><div class="center"><a href="ExtApp_Help.html">External Apps</a></div><div class="next"><a href="External_FCGI_Auth.html">Fast CGI Authorizer</a> »</div></div>
<h1>Fast CGI App</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header></header><p>
<a href="#extAppName">Name</a> | <a href="#extAppAddress">Address</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#persistConn">Persistent Connection</a> | <a href="#pcKeepAliveTimeout">Connection Keepalive Timeout</a> | <a href="#respBuffer">Response Buffering</a> | <a href="#autoStart">Start By Server</a> | <a href="#extAppPath">Command</a> | <a href="#backlog">Back Log</a> | <a href="#instances">Instances</a> | <a href="#extUser">Run As User</a> | <a href="#extGroup">Run As Group</a> | <a href="#extUmask">umask</a> | <a href="#runOnStartUp">Run On Start Up</a> | <a href="#extMaxIdleTime">Max Idle Time</a> | <a href="#extAppPriority">Priority</a> | <a href="#memSoftLimit">Memory Soft Limit (bytes)</a> | <a href="#memHardLimit">Memory Hard Limit (bytes)</a> | <a href="#procSoftLimit">Process Soft Limit</a> | <a href="#procHardLimit">Process Hard Limit</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="extAppName"><h3>Name<span class="ls-permlink"><a href="#extAppName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this external application. You will refer to it by this name when you use it in other parts of the configuration.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppAddress"><h3>Address<span class="ls-permlink"><a href="#extAppAddress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique socket address used by the external application. IPv4/IPv6 sockets and Unix Domain Sockets (UDS) are supported. IPv4/IPv6 sockets can be used for communication over the network. UDS can only be used when the external application resides on the same machine as the server.</p> <h4>Syntax</h4><p>IPv4 or IPV6 address:port or UDS://path</p> <h4>Example</h4><div class="ls-example">127.0.0.1:5434<br/> UDS://tmp/lshttpd/php.sock.</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If the external application runs on the same machine, UDS is preferred. If you have to use an IPv4|IPV6 socket, set the IP address to <span class="val">localhost</span> or <span class="val">127.0.0.1</span>, so the external application is inaccessible from other machines.<br/> <span title="Performance" class="ls-icon-performance"></span> Unix Domain Sockets generally provide higher performance than IPv4 sockets.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="initTimeout"><h3>Initial Request Timeout (secs)<span class="ls-permlink"><a href="#initTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds the server will wait for the external application to respond to the first request over a new established connection. If the server does not receive any data from the external application within this timeout limit, it will mark this connection as bad. This helps to identify communication problems with external applications as quickly as possible. If some requests take longer to process, increase this limit to avoid 503 error messages.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="retryTimeout"><h3>Retry Timeout (secs)<span class="ls-permlink"><a href="#retryTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the period of time that the server waits before retrying an external application that had a prior communication problem.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="persistConn"><h3>Persistent Connection<span class="ls-permlink"><a href="#persistConn"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to keep the connection open after a request has been processed. Persistent connections can increase performance, but some FastCGI external applications do not support persistent connections fully. The default is "On".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pcKeepAliveTimeout"><h3>Connection Keepalive Timeout<span class="ls-permlink"><a href="#pcKeepAliveTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds to keep an idle persistent connection open.<br/><br/> When set to "-1", the connection will never timeout. When set to 0 or greater, the connection will be closed after this time in seconds has passed.</p> <h4>Syntax</h4><p>int</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="respBuffer"><h3>Response Buffering<span class="ls-permlink"><a href="#respBuffer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to buffer responses received from external applications. If a "nph-" (Non-Parsed-Header) script is detected, buffering is turned off for responses with full HTTP headers.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoStart"><h3>Start By Server<span class="ls-permlink"><a href="#autoStart"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether you want the web server to start the application automatically. Only FastCGI and LSAPI applications running on the same machine can be started automatically. The IP in the <span class="tagl"><a href="#extAppAddress">Address</a></span> must be a local IP. Starting through the LiteSpeed CGI Daemon instead of a main server process will help reduce system overhead. CGI Daemon Async mode (non-blocking event-driven method) is recommended for servers with high I/O wait.<br/><br/> Default value: Yes (Through CGI Daemon Async)</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPath"><h3>Command<span class="ls-permlink"><a href="#extAppPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the full command line including parameters to execute the external application. Required value if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled. A parameter should be quoted with a double or single quote if the parameter contains space or tab characters.</p> <h4>Syntax</h4><p>Full path to the executable with optional parameters.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#autoStart">Start By Server</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="backlog"><h3>Back Log<span class="ls-permlink"><a href="#backlog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the backlog of the listening socket. Required if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="instances"><h3>Instances<span class="ls-permlink"><a href="#instances"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum instances of the external application the server will create. It is required if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled. Most FastCGI/LSAPI applications can only process one request per process instance and for those types of applications, instances should be set to match the value of <span class="tagl"><a href="#maxConns">Max Connections</a></span>. Some FastCGI/LSAPI applications can spawn multiple child processes to handle multiple requests concurrently. For these types of applications, instances should be set to "1" and environment variables used to control how many child processes the application can spawn.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extUser"><h3>Run As User<span class="ls-permlink"><a href="#extUser"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The external application will run as this specified user name. If not set, Virtual Host level settings will be inherited.<br/><br/> Default value: Not Set</p> <h4>Syntax</h4><p>Valid username.</p> <h4>See Also</h4><p class="ls-text-small">extGroup</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extGroup"><h3>Run As Group<span class="ls-permlink"><a href="#extGroup"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The external application will run as this specified group name. If not set, Virtual Host level settings will be inherited.<br/><br/> Default value: Not Set</p> <h4>Syntax</h4><p>Valid group name.</p> <h4>See Also</h4><p class="ls-text-small">extUser</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extUmask"><h3>umask<span class="ls-permlink"><a href="#extUmask"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Sets default umask for this external application's processes. See <span class="cmd"> man 2 umask </span> for details. The default value taken from the server-level <span class="tagl"><a href="ServSecurity_Help.html#umask">umask</a></span> setting.</p> <h4>Syntax</h4><p>value valid range [000]-[777].</p> <h4>See Also</h4><p class="ls-text-small">CGI <span class="tagl"><a href="ServSecurity_Help.html#umask">umask</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="runOnStartUp"><h3>Run On Start Up<span class="ls-permlink"><a href="#runOnStartUp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to start the external application at server start up. Only applicable to external applications that can manage their own child processes and where <span class="tagl"><a href="#instances">Instances</a></span> value is set to "1".<br/><br/> If enabled, external processes will be created at server startup instead of run-time.<br/><br/> When selecting "Yes (Detached mode)", all detached process can be restarted at the Server level or Virtual Host level by touching the '.lsphp_restart.txt' file under the $SERVER_ROOT/admin/tmp/ or $VH_ROOT/ directory respectively.<br/><br/> Default value: Yes (Detached mode)</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If the configured external process has significant startup overhead, like a Rails app, then this option should be enabled to decrease first page response time.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extMaxIdleTime"><h3>Max Idle Time<span class="ls-permlink"><a href="#extMaxIdleTime"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum idle time before an external application is stopped by the server, freeing idle resources. When set to "-1", the external application will not be stopped by the server unless running in ProcessGroup mode where idle external applications will be stopped after 30 seconds.<br/><br/> Default value: <span class="val">-1{/val}</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> This feature is especially useful in the mass hosting environment where, in order to prevent files owned by one virtual host from being accessed by the external application scripts of another virtual host, many different applications are run at the same time in SetUID mode. Set this value low to prevent these external applications from idling unnecessarily.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPriority"><h3>Priority<span class="ls-permlink"><a href="#extAppPriority"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies priority of the external application process. Value ranges from <span class="val">-20</span> to <span class="val">20</span>. A lower number means a higher priority. An external application process cannot have a higher priority than the web server. If this priority is set to a lower number than the server's, the server's priority will be used for this value.</p> <h4>Syntax</h4><p>int</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#serverPriority">Priority</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memSoftLimit"><h3>Memory Soft Limit (bytes)<span class="ls-permlink"><a href="#memSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the memory consumption limit in bytes for an external application process or an external application started by the server.<br/><br/> The main purpose of this limit is to prevent excessive memory usage because of software bugs or intentional attacks, not to impose a limit on normal usage. Make sure to leave enough head room, otherwise your application may fail and 503 error may be returned. It can be set at the server- level or at an individual external application level. The server-level limit will be used if it is not set at the individual application level.<br/><br/> The operating system's default setting will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application needs more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memHardLimit"><h3>Memory Hard Limit (bytes)<span class="ls-permlink"><a href="#memHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#memSoftLimit">Memory Soft Limit (bytes)</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level.<br/><br/> The operating system's default will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application need more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procSoftLimit"><h3>Process Soft Limit<span class="ls-permlink"><a href="#procSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Limits the total number of processes that can be created on behalf of a user. All existing processes will be counted against this limit, not just new processes to be started.<br/><br/> The limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default setting will be used if this value is 0 or absent at both levels.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> To control how many processes LSWS will make for users in mod_suEXEC mode, use the suEXEC Max Conn setting. PHP scripts can call for forking processes and the number of processes needed for normal functioning can be above the suEXEC Max Conn setting. The main purpose of this limit is as a last line of defense to prevent fork bombs and other attacks caused by PHP processes creating other processes.<br/><br/> Setting this setting too low can severely hurt functionality. The setting will thus be ignored below certain levels.<br/><br/> When <b>Run On Start Up</b> is set to "Yes (Daemon mode)", the actual process limit will be higher than this setting to make sure parent processes are not limited.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procHardLimit"><h3>Process Hard Limit<span class="ls-permlink"><a href="#procHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#procSoftLimit">Process Soft Limit</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default value will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
External_Servlet.html 0000644 00000026263 15055121352 0010730 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Servlet Engine</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Servlet Engine." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><span class="current"><a href="External_Servlet.html">Servlet Engine</a></span></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="External_LSAPI.html">LiteSpeed SAPI App</a></div><div class="center"><a href="ExtApp_Help.html">External Apps</a></div><div class="next"><a href="External_WS.html">Web Server</a> »</div></div>
<h1>Servlet Engine</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Servlet Engine</header><p>
<a href="#extAppName">Name</a> | <a href="#extAppAddress">Address</a> | <a href="#maxConns">Max Connections</a> | <a href="#pcKeepAliveTimeout">Connection Keepalive Timeout</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#respBuffer">Response Buffering</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="extAppName"><h3>Name<span class="ls-permlink"><a href="#extAppName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this external application. You will refer to it by this name when you use it in other parts of the configuration.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppAddress"><h3>Address<span class="ls-permlink"><a href="#extAppAddress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique socket address used by the external application. IPv4/IPv6 sockets and Unix Domain Sockets (UDS) are supported. IPv4/IPv6 sockets can be used for communication over the network. UDS can only be used when the external application resides on the same machine as the server.</p> <h4>Syntax</h4><p>IPv4 or IPV6 address:port or UDS://path</p> <h4>Example</h4><div class="ls-example">127.0.0.1:5434<br/> UDS://tmp/lshttpd/php.sock.</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If the external application runs on the same machine, UDS is preferred. If you have to use an IPv4|IPV6 socket, set the IP address to <span class="val">localhost</span> or <span class="val">127.0.0.1</span>, so the external application is inaccessible from other machines.<br/> <span title="Performance" class="ls-icon-performance"></span> Unix Domain Sockets generally provide higher performance than IPv4 sockets.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pcKeepAliveTimeout"><h3>Connection Keepalive Timeout<span class="ls-permlink"><a href="#pcKeepAliveTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds to keep an idle persistent connection open.<br/><br/> When set to "-1", the connection will never timeout. When set to 0 or greater, the connection will be closed after this time in seconds has passed.</p> <h4>Syntax</h4><p>int</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="initTimeout"><h3>Initial Request Timeout (secs)<span class="ls-permlink"><a href="#initTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds the server will wait for the external application to respond to the first request over a new established connection. If the server does not receive any data from the external application within this timeout limit, it will mark this connection as bad. This helps to identify communication problems with external applications as quickly as possible. If some requests take longer to process, increase this limit to avoid 503 error messages.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="retryTimeout"><h3>Retry Timeout (secs)<span class="ls-permlink"><a href="#retryTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the period of time that the server waits before retrying an external application that had a prior communication problem.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="respBuffer"><h3>Response Buffering<span class="ls-permlink"><a href="#respBuffer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to buffer responses received from external applications. If a "nph-" (Non-Parsed-Header) script is detected, buffering is turned off for responses with full HTTP headers.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
VHPageSpeed_Config.html 0000644 00000015472 15055121352 0011022 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Virtual Host PageSpeed Config</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Virtual Host PageSpeed Config." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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>
<span class="current"><a href="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a></span>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="VHSSL_Help.html">Virtual Host SSL</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="Rewrite_Help.html">Rewrite</a> »</div></div>
<h1>Virtual Host PageSpeed Config</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>PageSpeed Settings</header><p>
<a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Templates_Help.html 0000644 00000035444 15055121352 0010351 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Virtual Host Templates</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Virtual Host Templates." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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><span class="current"><a href="Templates_Help.html">Virtual Host Templates</a></span></li>
<li><a href="VirtualHosts_Help.html">Virtual Host Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Listeners_SSL_Help.html">Listeners SSL</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="VirtualHosts_Help.html">Virtual Hosts Basic</a> »</div></div>
<h1>Virtual Host Templates</h1><section class="ls-spacer-small-bottom">Virtual host templates make it easy to create many new virtual
hosts with similar configurations.
Each template contains a template configuration file, a list of mapped listeners,
and a list of member virtual hosts.
To add a template-based virtual host, the administrator only needs to
add a member with a unique virtual host name and a
qualified domain name to the template member list.
Listener-to-virtual host mapping will be added automatically for
all listeners in the template's mapped listener list.
Later on, if you need to customize the configuration for a particular
virtual host, just "instantiate" that member virtual host and a
standalone virtual host configuration will be created automatically.
Even when setting up a customized virtual host,
a template can still be a convenient starting point.</section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Template Location</header><p>
<a href="#templateName">Template Name</a> | <a href="#templateFile">Template File</a> | <a href="#mappedListeners">Mapped Listeners</a></p></section>
<section class="toc-row"><header>Member Virtual Hosts</header><p>
<a href="#templateVHName">Virtual Host Name</a> | <a href="#templateVHDomain">Domain</a> | <a href="#templateVHAliases">Aliases</a> | <a href="#memberVHRoot">Member Virtual Host Root</a></p></section>
<section class="toc-row"><header>Template Settings</header><p>
<a href="#templateVHRoot">Default Virtual Host Root</a> | <a href="#templateVHConfigFile">Instantiated VHost Config File</a> | <a href="#templateVHDocRoot">Document Root</a> | <a href="#templateFileRef">Config File</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="templateName"><h3>Template Name<span class="ls-permlink"><a href="#templateName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for the template.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="templateFile"><h3>Template File<span class="ls-permlink"><a href="#templateFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the path to the configuration file of this template. The file must be located within $SERVER_ROOT/conf/templates/ with a ".xml" filename. If the file you designate does not exist, after trying to save the template an error will appear with the link "CLICK TO CREATE". This link will generate a new empty template file. When you delete the template, the entry will be removed from your configurations, but the actual template config file will not be deleted.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="mappedListeners"><h3>Mapped Listeners<span class="ls-permlink"><a href="#mappedListeners"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the names of all listeners that this template maps to. A listener-to-virtual host mapping for this template's member virtual hosts will be added to the listeners specified in this field. This mapping will map listeners to virtual hosts based on the domain names and aliases set in the member virtual hosts' individual configurations.</p> <h4>Syntax</h4><p>comma-separated list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="templateVHName"><h3>Virtual Host Name<span class="ls-permlink"><a href="#templateVHName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this virtual host. This name must be unique among all template member virtual hosts and standalone virtual hosts. Inside a directory path configuration, this name can be referenced by the variable <span class="val">$VH_NAME</span>.<br/><br/> If a standalone virtual host with the same name is also configured, then the member virtual host configuration will be ignored.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="templateVHDomain"><h3>Domain<span class="ls-permlink"><a href="#templateVHDomain"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the main domain name for this member virtual host. If left blank, the virtual host name will be used. This should be a fully qualified domain name, but you can use an IP address as well. It is recommended to append <span class="val">:<port></span> for web sites not on port 80. For configurations containing domain names, this domain can be referenced with variable <span class="val">$VH_DOMAIN</span>.<br/><br/> This domain name will be used in the following situations: <ol> <li>To match the hostname in the Host header when processing a request.</li> <li>To populate domain name configurations for add-ons like FrontPage or AWstats.</li> <li>To configure listener-to-virtual host mappings based on the virtual host template.</li> </ol></p> <h4>Syntax</h4><p>domain name</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="templateVHAliases"><h3>Aliases<span class="ls-permlink"><a href="#templateVHAliases"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies alternate names for the virtual host. All possible hostnames and IP addresses should be added to this list. The wildcard characters <span class="val">*</span> and <span class="val">?</span> are allowed in the name. Append <span class="val">:<port></span> for web sites not on port 80.<br/><br/> Aliases will be used in the following situations: <ol> <li>To match the hostname in the Host header when processing a request.</li> <li>To populate domain name/alias configurations for add-ons like FrontPage or AWstats.</li> <li>To configure listener-to-virtual host mappings based on the virtual host template.</li> </ol></p> <h4>Syntax</h4><p>Comma-separated list of domain names.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memberVHRoot"><h3>Member Virtual Host Root<span class="ls-permlink"><a href="#memberVHRoot"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the root directory of this virtual host. If left blank, the default virtual host root for this template will be used.<br/><br/> Note: This is <b>NOT</b> the document root. It is recommended to place all files related to the virtual host (like virtual host configuration, log files, html files, CGI scripts, etc.) under this directory. Virtual host root can be referred to as $VH_ROOT.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="templateVHRoot"><h3>Default Virtual Host Root<span class="ls-permlink"><a href="#templateVHRoot"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the default root directory for member virtual hosts using this template. Variable <span class="val">$VH_NAME</span> must appear in the path. This will allow each member template to be automatically assigned a separate root directory based on its name.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="templateVHConfigFile"><h3>Instantiated VHost Config File<span class="ls-permlink"><a href="#templateVHConfigFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the config file generated when you instantiate a member virtual host. Variable <span class="val">$VH_NAME</span> must appear in the path so each virtual host will have its own file. Suggested location is <span class="val">$SERVER_ROOT/conf/vhosts/$VH_NAME.xml</span>. This config file will be created only after you move a member vhost out of the template through instantiation.</p> <h4>Syntax</h4><p>String with $VH_NAME variable and .xml suffix</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="templateVHDocRoot"><h3>Document Root<span class="ls-permlink"><a href="#templateVHDocRoot"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the unique path for each member virtual host's document root. Variable <span class="val">$VH_NAME</span> or <span class="val">$VH_ROOT</span> must appear in the path so each member virtual host will have its own document root.</p> <h4>Syntax</h4><p>path with $VH_NAME or $VH_ROOT variable</p> <h4>Example</h4><div class="ls-example">$VH_ROOT/public_html/ or $SERVER_ROOT/$VH_NAME/public_html.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="templateFileRef"><h3>Config File<span class="ls-permlink"><a href="#templateFileRef"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the unique path for each member virtual host's configuration file. Variable <span class="val">$VH_NAME</span> or <span class="val">$VH_ROOT</span> must appear in the path so each member virtual host will have its own configuration file.</p> <h4>Syntax</h4><p>path with $VH_NAME or $VH_ROOT variable</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
css/hdoc.css 0000644 00000017014 15055121352 0006765 0 ustar 00 font-face {
font-family: 'Open Sans';
src:
local('OPENSSANS-REGULAR'),
url ('/font/OPENSSANS-REGULAR.TTF')
format('truetype');
}
body,td,a,p{font-family: 'Open Sans', sans-serif;}
body {color: #555; font-size: 11pt; background-color: #293e6a;}
.pagewrapper {width: 60%; min-width: 800px; max-width: 1200px; margin: 25px auto; display:block; padding: 0px 0 35px 0; background-color: #FFF; display: flex; flex-wrap: wrap;}
/*.sidetree { width: 200px; padding: 15px; padding-left: 15px; border: 0;background-color: #e6f2ff;float: left;}*/
.sidetree {width: 200px; padding: 15px; padding-left: 20px; padding-top:38px; background-color: #fafcff; font-size:10pt;}
.sidetree figure {
margin-bottom: 20px;
margin-left: 0px;
}
.contentwrapper { padding: 0px 35px 50px 50px;}
h1 {font-size: 24pt; line-height: 36px; margin: 20px 0 35px 0;}
h2 {font-size: 16pt;}
h3 {font-size: 13pt; line-height: 24px;}
h4 {font-size: 12pt; line-height: 16px;}
h2,h3 { margin: 20px 0 10px 0;}
h1,h2,h3,h4 {font-weight: 100;}
h5 {color: #555; font-weight: 400; font-size: 10pt; line-height:5px;}
.ls-text-thin {font-weight: 100;}
.ls-text-thinner {font-weight: 300;}
.ls-text-xlarge {font-size: 32pt; line-height: 42px;}
.ls-text-large {font-size: 24pt; line-height: 36px;}
.ls-text-medium {font-size: 14pt; line-height: 28px;}
.ls-text-small {font-size: 10.5pt; line-height: 14px;}
.ls-text-muted {color: #999;}
.ls-text-blue {color:#4a70bf;}
.ls-text-italic {font-style: italic;}
.ls-spacer-micro-top {margin-top: 35px;}
.ls-spacer-small-top {margin-top: 50px;}
.ls-spacer-large-top {margin-top: 100px;}
.ls-spacer-micro-bottom {margin-bottom: 35px;}
.ls-spacer-small-bottom {margin-bottom: 50px;}
.ls-spacer-large-bottom {margin-bottom: 100px;}
.ls-text-style-upper-roman {list-style-type: upper-roman; list-style-position: inside; padding-left: 5px;}
.ls-toc-text-right {float:right;}
.ls-col-1-5 {width:20%; min-width: 200px;}
.ls-col-2-5 {width:40%;}
.ls-col-3-5 {width:60%; min-width: 400px;}
.ls-col-4-5 {width:80%;}
.ls-col-1-1 {width:100%;}
section.ls-index {margin-top: 50px;}
section.ls-index h1:first-child {font-weight: 100; font-size: 32pt; line-height: 42px;color: #598bd9;}
section.ls-index h1:nth-child(2) {font-weight: 100; font-weight: 100; font-size: 32pt; line-height: 42px; margin-bottom: 25px;margin-top: 50px;}
section.ls-index h1:last-child {font-weight: 100; margin-bottom: 35px;font-size: 24pt; line-height: 28px; color: #999;}
section.ls-index h3 {font-weight: 100; font-size: 24pt; line-height: 36px; margin-bottom: 50px; margin-top: 50px;}
section.ls-index ol {list-style-type: upper-roman; list-style-position: inside; padding-left: 5px;}
section.ls-index ol li {font-weight: 100; font-size: 14pt; line-height: 28px;}
section.ls-index ol li span {float:right;}
section.ls-index p {margin-top: 100px; float:right;}
.ls-eula {padding-left: 10px;}
.ls-eula h3 {margin-top: 50px; margin-bottom: 35px;font-weight: 400;}
.ls-eula h4 {margin-top: 35px;font-weight: 400;}
.ls-eula p {font-family: monospace; margin: 1em 0px 1em 0px; font-weight: 400; display:block; text-align: justify; line-height:14pt; }
.ls-eula ul li {font-family: monospace; list-style: none; font-size: 12pt; line-height: 14pt;margin: 10px 0 20px 0; }
.ls-eula ul {margin: 25px 0 35px 0;}
.ls-font-monospace {font-family: monospace; margin: 1em 0px 1em; display:block; text-align: justify;}
.ls-text-white {color: #FFF;}
article .ls-helpitem {
font-size: 11pt;
margin-top: 50px;
}
.helpitem {display: block; margin: 20px 0 10px 0; position: relative;}
article h4 {
margin-top: 30px;
margin-bottom: 0px!important;
}
.ls-helpitem header {
margin-top: 30px;
}
.ls-helpitem header>h3 {
color: #737054;
font-size: 14pt;
line-height: 28px;
margin-top: 50px;
font-weight: 400;
}
.ls-example h5 {
color:#fff;
font-weight: 600;
margin-bottom: 15px;
line-height: 14pt;
}
.ls-example p {
color:#fff;
margin-bottom: 35px;
}
.clearfix:after {
content: "";
display: table;
clear: both;
}
hr {background: #aaa; height: 1px; border: 0; margin-bottom: 20px;}
ol {display: block; list-style-type: decimal;}
ol li, ul li { margin: 7px 0;}
.sidetree ul { list-style-type: none; color:#4a70bf; padding:5px; margin:0; font-weight: 600; }
.sidetree ul .level2 { list-style-type: square; padding: 0 0 0 25px; margin:0; font-weight:400; }
.sidetree ul .level3 { list-style-type: circle; padding: 0 0 0 25px; margin:0; font-weight:400; }
.sidetree .current a, .sidetree .current a:visited {color:#E67E22;font-weight:600;}
a, a:visited {text-decoration: none; color: #598bd9; }
a:hover{ color: #4caf50; }
.toc-row {margin-bottom: 35px;}
.toc-row header {color: #666; font-size: 16px; font-weight: 400;}
.toc-row p {color:#96926e; font-size: 14px; line-height: 24px;}
.toc a{color: #96926e;}
.toc a:hover{color: #c27514;}
.toc {display: block; padding: 20px 20px 50px 20px; background-color:#faf8f8; border-radius: 3px; box-shadow: 0px 1px 2px rgba(0,0,0,0.2)}
.ls-example {display: block; padding: 20px 20px 20px 20px; color: #eee; background-color:#333; border-radius: 3px; box-shadow: 0px 1px 2px rgba(0,0,0,0.2); margin:10px 0 25px 0;}
.ht { background-color: transparent; font-size: 13px; color: #555;}
.ht-title { font-weight: 600; font-size: 14px; color: #96926e; }
.ht-label { font-weight: 600; color: #555; font-size: 13px;}
.top { font-size: 24px; text-align: right; float:right; margin-top:-3px; }
.top a, .top a:visited {color: #ccc; }
.top a:hover {color: #96926e; }
.cmd {
padding: 0 3px 2px;
font-family: Monaco, Menlo, Consolas, "Courier New", monospace;
font-size: 12px;
color: #d14;
background-color: #f7f7f9;
border: 1px solid #e1e1e8;
white-space: pre-wrap;
-webkit-border-radius: 3px;
-moz-border-radius: 3px;
border-radius: 3px;
}
.tag { padding: 0 3px 1px; font-size: 12px; color: #fff; background-color: #B6A87C;
white-space: nowrap; -webkit-border-radius: 3px; -moz-border-radius: 3px; border-radius: 3px;}
.val { color: #ac7339; font-weight: 400 }
.tagI, .tagP {font-weight: bold }
.tagI a:hover, .tagP a:hover { text-decoration: underline }
.copyright {font-size: 11px; color: #aaa; text-align: center; border-top: 1px solid #ddd; padding-top: 20px; display:block;}
.copyright a, .copyright a:visited { color: #598bd9; text-decoration: none}
.copyright a:hover, #copyright a:active {color: #4caf50; text-decoration: underline}
.nav-bar { height:18px; width: 100%; border-bottom: 1px solid #bbb; color: #888; font-size: 14px; padding: 5px; margin-bottom: 50px;}
.nav-bar a, .nav-bar a visited { color: #598bd9; text-decoration: none; }
.nav-bar a:hover {text-decoration: underline; color:#4caf50;}
.nav-bar .prev {text-align: left; float: left; width: 33%;}
.nav-bar .center {text-align: center; float: left; width: 33%;}
.nav-bar .next {text-align: right; float: right; width: 33%;}
.ls-icon-performance {
display: inline-block;
background: url(/docs/img/lightning-bolt.svg)no-repeat;
width: 16px;
height: 14px;
background-size: contain;
}
.ls-icon-security {
display: inline-block;
background: url(/docs/img/shield.svg)no-repeat;
width: 16px;
height: 14px;
background-size: contain;
}
.ls-icon-info {
display: inline-block;
background: url(/docs/img/info.svg)no-repeat;
width: 16px;
height: 14px;
background-size: contain;
}
.ls-icon-attention {
display: inline-block;
background: url(/docs/img/attention.svg)no-repeat;
width: 16px;
height: 14px;
background-size: contain;
}
.ls-permlink a:after {
content: "\00a0 \0023";
color: #ccc;
}
.ls-permlink a:hover::after {
color: #96926e;
}
VHGeneral_Help.html 0000644 00000120477 15055121352 0010227 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Virtual Host General</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Virtual Host General." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</a></li>
<li><span class="current"><a href="VHGeneral_Help.html">Virtual Host General</a></span></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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="VirtualHosts_Help.html">Virtual Hosts Basic</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>
<h1>Virtual Host General</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>General</header><p>
<a href="#docRoot">Document Root</a> | <a href="#vhadminEmails">Administrator Email</a> | <a href="#vhEnableGzip">Enable Compression</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#cgroups">cgroups</a></p></section>
<section class="toc-row"><header>Virtual Host Log</header><p>
<a href="#logUseServer">Use Server's Log</a> | <a href="#vhlog_fileName">File Name</a> | <a href="#vhlog_logLevel">Log Level</a> | <a href="#log_rollingSize">Rolling Size (bytes)</a> | <a href="#log_keepDays">Keep Days</a> | <a href="#log_compressArchive">Compress Archive</a></p></section>
<section class="toc-row"><header>Access Log</header><p>
<a href="#aclogUseServer">Log Control</a> | <a href="#vhaccessLog_fileName">File Name</a> | <a href="#accessLog_pipedLogger">Piped Logger</a> | <a href="#accessLog_logFormat">Log Format</a> | <a href="#accessLog_logHeader">Log Headers</a> | <a href="#log_rollingSize">Rolling Size (bytes)</a> | <a href="#log_keepDays">Keep Days</a> | <a href="#log_compressArchive">Compress Archive</a> | <a href="#accessLog_bytesLog">Bytes Log</a></p></section>
<section class="toc-row"><header>Index Files</header><p>
<a href="#indexUseServer">Use Server Index Files</a> | <a href="#indexFiles">Index Files</a> | <a href="#autoIndex">Auto Index</a> | <a href="#autoIndexURI">Auto Index URI</a></p></section>
<section class="toc-row"><header><a href="#errPage">Customized Error Pages</a></header><p>
<a href="#errCode">Error Code</a> | <a href="#errURL">URL</a></p></section>
<section class="toc-row"><header>Script Handler Definition</header><p>
<a href="#suffix">Suffix</a> | <a href="#shType">Handler Type</a> | <a href="#shHandlerName">Handler Name</a></p></section>
<section class="toc-row"><header><a href="#htaccess">HT Access</a></header><p>
<a href="#allowOverride">Allow Override</a> | <a href="#accessFileName">Access File Name</a></p></section>
<section class="toc-row"><header>Expire Settings</header><p>
<a href="#enableExpires">Enable Expires</a> | <a href="#expiresDefault">Expires Default</a> | <a href="#expiresByType">Expires By Type</a></p></section>
<section class="toc-row"><header>Apache Style Configuration</header><p>
<a href="#apacheConf">Apache Style Configurations</a></p></section>
<section class="toc-row"><header>Web Socket Proxy</header><p>
<a href="#wsuri">URI</a> | <a href="#wsaddr">Address</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="docRoot"><h3>Document Root<span class="ls-permlink"><a href="#docRoot"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="vhadminEmails"><h3>Administrator Email<span class="ls-permlink"><a href="#vhadminEmails"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="vhEnableGzip"><h3>Enable Compression<span class="ls-permlink"><a href="#vhEnableGzip"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>, <span class="tagl"><a href="ServTuning_Help.html#enableBrCompress">Brotli Compression Level (Dynamic Content)</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="cgroups"><h3>cgroups<span class="ls-permlink"><a href="#cgroups"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="logUseServer"><h3>Use Server's Log<span class="ls-permlink"><a href="#logUseServer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="vhlog_fileName"><h3>File Name<span class="ls-permlink"><a href="#vhlog_fileName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Place the log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vhlog_logLevel"><h3>Log Level<span class="ls-permlink"><a href="#vhlog_logLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-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"><div><header id="log_rollingSize"><h3>Rolling Size (bytes)<span class="ls-permlink"><a href="#log_rollingSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></span> Append "K", "M", "G" to the number for kilo-, mega- and giga- bytes.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="log_keepDays"><h3>Keep Days<span class="ls-permlink"><a href="#log_keepDays"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="log_compressArchive"><h3>Compress Archive<span class="ls-permlink"><a href="#log_compressArchive"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></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"><div><header id="aclogUseServer"><h3>Log Control<span class="ls-permlink"><a href="#aclogUseServer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="vhaccessLog_fileName"><h3>File Name<span class="ls-permlink"><a href="#vhaccessLog_fileName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Put access log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessLog_pipedLogger"><h3>Piped Logger<span class="ls-permlink"><a href="#accessLog_pipedLogger"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="accessLog_logFormat"><h3>Log Format<span class="ls-permlink"><a href="#accessLog_logFormat"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="accessLog_logHeader"><h3>Log Headers<span class="ls-permlink"><a href="#accessLog_logHeader"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-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"><div><header id="accessLog_bytesLog"><h3>Bytes Log<span class="ls-permlink"><a href="#accessLog_bytesLog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Put the log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="indexUseServer"><h3>Use Server Index Files<span class="ls-permlink"><a href="#indexUseServer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="indexFiles"><h3>Index Files<span class="ls-permlink"><a href="#indexFiles"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Only set index files that you need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoIndex"><h3>Auto Index<span class="ls-permlink"><a href="#autoIndex"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Security" class="ls-icon-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"><div><header id="autoIndexURI"><h3>Auto Index URI<span class="ls-permlink"><a href="#autoIndexURI"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="errPage"><h3>Customized Error Pages<span class="ls-permlink"><a href="#errPage"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="errCode"><h3>Error Code<span class="ls-permlink"><a href="#errCode"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="errURL"><h3>URL<span class="ls-permlink"><a href="#errURL"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="suffix"><h3>Suffix<span class="ls-permlink"><a href="#suffix"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></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 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. You can thus use the Apache configuration directives "AddType" and "ForceType" (which control file MIME types) in .htaccess files to change which script handler certain files will use. For example, with the directive <span class="cmd"> AddType application/x-httpd-php53 .php</span> in a properly placed .htaccess file, you can stipulate that php files in this directory have the MIME type "application/x-httpd-php53" and thus will be handled by the script handler that uses MIME type "application/x-httpd-php53" (suffix "php53"). This then allows you to assign different script handlers, not only for different file suffixes, but also based on the locations of files.<br/> <span title="Performance" class="ls-icon-performance"></span><span title="Security" class="ls-icon-security"></span> Only specify the suffixes you really need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="shType"><h3>Handler Type<span class="ls-permlink"><a href="#shType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the type of external application that processes these script files. Available types are: <span class="val">CGI</span>, <span class="val">FastCGI</span>, <span class="val">Web Server</span>, <span class="val">LSAPI app</span>, <span class="val">Load balancer</span>, or <span class="val">Servlet Engine</span>. For FastCGI, Web Server and Servlet Engine, a <span class="tagl"><a href="#shHandlerName">Handler Name</a></span> needs to be specified. This is an external application name as predefined 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"><div><header id="shHandlerName"><h3>Handler Name<span class="ls-permlink"><a href="#shHandlerName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the external application that processes the script files when the handler type is FastCGI, Web Server, LSAPI, Load Balancer, or Servlet Engine.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="htaccess"><h3>HT Access<span class="ls-permlink"><a href="#htaccess"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The following directives are supported in a directory level access control file (.htaccess file).<br/> <ul> <li> Authentication <ul> <li>AuthGroupFile</li> <li>AuthName</li> <li>AuthType</li> <li>AuthUserFile</li> <li>Require</li> <li>Satisfy</li> <li><Limit> (GET, HEAD, POST only)</li> <li><LimitExcept> (GET, HEAD, POST only)</li> </ul> </li> <li> Access Control <ul> <li>Allow</li> <li>Deny</li> <li>Order</li> <li><Limit> (GET, HEAD, POST only)</li> <li><LimitExcept> (GET, HEAD, POST only)</li> </ul> </li> <li> File Info <ul> <li>AddDefaultCharset</li> <li>AddType</li> <li>DefaultType</li> <li>ForceType</li> <li>Redirect</li> <li>RedirectPermanent</li> <li>RedirectTemp</li> <li>RewriteBase</li> <li>RewriteCond</li> <li>RewriteEngine</li> <li>RewriteOptions</li> <li>RewriteRule</li> </ul> </li> <li> Other <ul> <li>DirectoryIndex</li> <li>ExpiresActive</li> <li>ExpiresByType</li> <li>ExpiresDefault</li> <li>Options</li> </ul> </li> </ul></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessFileName"><h3>Access File Name<span class="ls-permlink"><a href="#accessFileName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of access control files. These files will be used only if <span class="tagl"><a href="#allowOverride">Allow Override</a></span> is enabled. Default name is <span class="val">.htaccess</span>. You can configure this at server level and virtual host level. Server level is the default setting, and you can override it at virtual host level.</p> <h4>Syntax</h4><p>Filename starting with "."</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#allowOverride">Allow Override</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableExpires"><h3>Enable Expires<span class="ls-permlink"><a href="#enableExpires"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresDefault"><h3>Expires Default<span class="ls-permlink"><a href="#expiresDefault"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresByType"><h3>Expires By Type<span class="ls-permlink"><a href="#expiresByType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="apacheConf"><h3>Apache Style Configurations<span class="ls-permlink"><a href="#apacheConf"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies Apache configuration directives (supported by LiteSpeed) that you want to use in LiteSpeed native configuration file. For example, to override the default PHP configurations (php.ini entries) the server will need four directives: "php_value", "php_flag", "php_admin_value" and "php_admin_flag".</p> <h4>Syntax</h4><p>Same as Apache configuration file.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="wsuri"><h3>URI<span class="ls-permlink"><a href="#wsuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the URI(s) that will use this WebSocket backend. Traffic to this URI will only be forwarded to the WebSocket backend when it contains a WebSocket upgrade request. <br/><br/> Traffic without this upgrade request will automatically be forwarded to the Context that this URI belongs to. If no Context exists for this URI, LSWS will treat this traffic as though it is accessing a static context with the location <span class="val">$DOC_ROOT/URI</span>.</p> <h4>Syntax</h4><p>A plain URI (starting with "/"). If the URI ends with a "/", then this WebSocket backend will include all sub-URIs under this URI.</p> <h4>Example</h4><div class="ls-example">Using the WebSocket proxy in conjunction with a Context allows you to serve different kinds of traffic in different ways on the same page, thus optimizing performance. You can send WebSocket traffic to the WebSocket backend, while setting up a static context so that LSWS can serve the page's static content, or an LSAPI context so LSWS will serve PHP content (both of which LSWS does more efficiently than the WebSocket backend).</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="wsaddr"><h3>Address<span class="ls-permlink"><a href="#wsaddr"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique socket address used by the WebSocket backend. IPv4 sockets, IPv6 sockets, and Unix Domain Sockets (UDS) are supported. IPv4 and IPv6 sockets can be used for communication over the network. UDS can only be used when the WebSocket backend resides on the same machine as the server.</p> <h4>Syntax</h4><p>IPv4/IPv6 address:port, UDS://path, or unix:path</p> <h4>Example</h4><div class="ls-example">127.0.0.1:5434 <br/> UDS://tmp/lshttpd/php.sock<br/> unix:/tmp/lshttpd/php.sock</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If the WebSocket backend runs on the same machine, UDS is preferred. If you have to use an IPv4 or IPv6 socket, set the IP address to localhost or 127.0.0.1, so the WebSocket backend is inaccessible from other machines.<br/> <span title="Performance" class="ls-icon-performance"></span> Unix Domain Sockets generally provide higher performance than IPv4 or IPv6 sockets.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Rewrite_Help.html 0000644 00000031637 15055121352 0010034 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Rewrite</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Rewrite." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><span class="current"><a href="Rewrite_Help.html">Rewrite</a></span></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="Context_Help.html">Context</a> »</div></div>
<h1>Rewrite</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Rewrite Control</header><p>
<a href="#enableRewrite">Enable Rewrite</a> | <a href="#rewriteLogLevel">Log Level</a></p></section>
<section class="toc-row"><header>Rewrite Map</header><p>
<a href="#rewriteMapName">Name</a> | <a href="#rewriteMapLocation">Location</a></p></section>
<section class="toc-row"><header>Rewrite Rules</header><p>
<a href="#rewriteRules">Rewrite Rules</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="enableRewrite"><h3>Enable Rewrite<span class="ls-permlink"><a href="#enableRewrite"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable LiteSpeed's URL rewrite engine. This option can be customized at the virtual host or context level, and is inherited along the directory tree until it is explicitly overridden.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteLogLevel"><h3>Log Level<span class="ls-permlink"><a href="#rewriteLogLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the level of detail of the rewrite engine's debug output. This value ranges from <span class="val">0</span> - <span class="val">9</span>. <span class="val">0</span> disables logging. <span class="val">9</span> produces the most detailed log. The server and virtual host's error log <span class="tagl"><a href="ServGeneral_Help.html#log_logLevel">Log Level</a></span> must be set to at least <span class="val">INFO</span> for this option to take effect. This is useful when testing rewrite rules.</p> <h4>Syntax</h4><p>Integer number</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#log_logLevel">Log Level</a></span>, Virtual Host <span class="tagl"><a href="VHGeneral_Help.html#vhlog_logLevel">Log Level</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteMapName"><h3>Name<span class="ls-permlink"><a href="#rewriteMapName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a unique name for the rewrite map at the virtual host level. This name will be used by a mapping-reference in rewrite rules. When referencing this name, one of the following syntaxes should be used: <blockquote><code> $\{MapName:LookupKey\}<br/> $\{MapName:LookupKey|DefaultValue\} </code></blockquote><br/> The implementation of LiteSpeed's rewrite engine follows the specifications of Apache's rewrite engine. For more details about rewrite maps, please refer to <a href="http://httpd.apache.org/docs/current/mod/mod_rewrite.html" target="_blank" rel="noopener noreferrer">Apache's mod_rewrite document</a>.</p> <h4>Syntax</h4><p>string</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteMapLocation"><h3>Location<span class="ls-permlink"><a href="#rewriteMapLocation"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the rewrite map using the syntax <span class="val">MapType:MapSource</span>.<br/> LiteSpeed's rewrite engine supports three types of rewrite maps: <ul> <li><b>Standard Plain Text</b> <blockquote> <b>MapType:</b> txt; <br/> <b>MapSource:</b> file path to a valid plain ASCII file. </blockquote> Each line of this file should contain two elements separated by blank spaces. The first element is the key and the second element is the value. Comments can be added with a leading "<span class="val">#</span>" sign. </li> <li><b>Randomized Plain Text</b> <blockquote> <b>MapType:</b> rnd;<br/> <b>MapSource:</b> file path of a valid plain ASCII file. </blockquote> File format is similar to the Standard Plain Text file, except that the second element can contain multiple choices separated by a "<span class="val">|</span>" sign and chosen randomly by the rewrite engine. </li> <li><b>Internal Function</b> <blockquote> <b>MapType:</b> int;<br/> <b>MapSource:</b> Internal string function </blockquote> 4 functions are available: <ul> <li><b>toupper:</b> converts lookup key to upper cases.</li> <li><b>tolower:</b> converts lookup key to lower cases.</li> <li><b>escape:</b> perform URL encoding on lookup key.</li> <li><b>unescape:</b> perform URL decoding on lookup key.</li> </ul> </li> The following map types available in Apache have not been implemented in LiteSpeed:<br/> Hash File and External Rewriting Program. </ul> The implementation of LiteSpeed's rewrite engine follows the specifications of Apache's rewrite engine. For more details about rewrite map, please refer to <a href="http://httpd.apache.org/docs/current/mod/mod_rewrite.html" target="_blank" rel="noopener noreferrer">Apache's mod_rewrite document</a>.</p> <h4>Syntax</h4><p>String</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteRules"><h3>Rewrite Rules<span class="ls-permlink"><a href="#rewriteRules"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a list of rewrite rules at the virtual host level.<br/><br/> Do NOT add any document root level rewrite rules here. If you have any document root level rewrite rules from .htaccess, you should instead create a static context with uri "/" and add the rewrite rules there.<br/><br/> A rewrite rule is comprised of one <span class="val">RewriteRule</span> directive and optionally preceded by multiple <span class="val">RewriteCond</span> directives. <ul> <li>Each directive should take only one line.</li> <li> <span class="val">RewriteCond</span> and <span class="val">RewriteRule</span> follow Apache's rewrite directive syntax. Just copy and paste rewrite directives from your Apache configuration files. </li> <li> There are minor differences between LiteSpeed and Apache mod_rewrite implementation: <ul> <li> <span class="val">%\{LA-U:variable\}</span> and <span class="val">%\{LA-F:variable\}</span> are ignored by the LiteSpeed rewrite engine </li> <li> Two new server variables are added in the LiteSpeed rewrite engine: <span class="val">%\{CURRENT_URI\}</span> represents the current URI being processed by the rewrite engine and <span class="val">%\{SCRIPT_NAME\}</span> has the same meaning as the corresponding CGI environment variable. </li> <li> The LiteSpeed rewrite engine will stop processing rewrite rules after encountering an <span class="val">[L]</span> flag to avoid looping while Apache mod_rewrite will stop processing rewrite rules for the current iteration only. This behavior is similar to that of the <span class="val">[END]</span> flag in Apache mod_rewrite. </li> </ul> </li> </ul><br/> The implementation of LiteSpeed's rewrite engine follows Apache's rewrite engine specifications. For more details about rewrite rules, please refer to <a href="https://httpd.apache.org/docs/current/mod/mod_rewrite.html" target="_blank" rel="noopener noreferrer"> Apache's mod_rewrite document </a> and <a href="https://httpd.apache.org/docs/current/rewrite/" target="_blank" rel="noopener noreferrer"> Apache's URL rewriting guide </a>.</p> <h4>Syntax</h4><p>string</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
LB_Context.html 0000644 00000062536 15055121352 0007446 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Load Balancer Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Load Balancer Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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><span class="current"><a href="LB_Context.html">Load Balancer Context</a></span></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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="CGI_Context.html">CGI Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="Redirect_Context.html">Redirect Context</a> »</div></div>
<h1>Load Balancer Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#lbContext">Load Balancer Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#lbapp">Load Balancer</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="lbContext"><h3>Load Balancer Context<span class="ls-permlink"><a href="#lbContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Like other external applications, load balancer worker applications cannot be used directly. They must be mapped to a URL through a context. A Load Balancer Context will associate a URI to be load balanced by the load balancer workers.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="lbapp"><h3>Load Balancer<span class="ls-permlink"><a href="#lbapp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the load balancer to be associated to this context. This load balancer is a virtual application, and must be defined in the <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> section at the server or virtual host level.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
img/shield.svg 0000644 00000002736 15055121352 0007320 0 ustar 00 <?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="12px" height="12px" viewBox="0 0 12 12" enable-background="new 0 0 12 12" xml:space="preserve">
<g>
<g>
<path fill="#006699" d="M6,1.581c-0.11,0.088-1.625,1.275-3.567,1.684C2.176,7.982,5.997,10.426,6,10.424
c0.002,0.002,3.825-2.441,3.568-7.159C7.625,2.855,6,1.581,6,1.581z"/>
<path fill="#006699" d="M10.83,2.504c-0.008-0.143-0.105-0.262-0.24-0.291c-2.367-0.5-4.391-2.067-4.411-2.083
C6.072,0.047,5.925,0.047,5.818,0.132c-0.08,0.064-1.98,1.569-4.409,2.081c-0.133,0.028-0.232,0.147-0.24,0.291
C0.975,6.089,2.573,8.67,3.948,10.201c0.516,0.576,1,1.001,1.316,1.255c0.18,0.147,0.327,0.254,0.417,0.319
c0.169,0.12,0.217,0.154,0.311,0.156c0.004,0,0.008,0,0.012,0c0.092,0,0.148-0.039,0.294-0.143
c0.079-0.055,0.208-0.149,0.368-0.276c0.279-0.223,0.712-0.593,1.184-1.092c0.885-0.938,1.59-1.983,2.096-3.105
C10.625,5.805,10.922,4.188,10.83,2.504z M8.206,9.054c-0.909,1.2-1.85,1.932-2.207,2.188c-0.356-0.256-1.297-0.987-2.207-2.189
C2.37,7.173,1.685,5.064,1.757,2.78c2.051-0.487,3.709-1.614,4.245-2.009C6.545,1.165,8.231,2.3,10.242,2.78
C10.316,5.064,9.631,7.174,8.206,9.054z"/>
</g>
</g>
</svg>
img/ols_logo.svg 0000644 00000006726 15055121352 0007670 0 ustar 00 <?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="150px" height="100px" viewBox="0 0 150 100" enable-background="new 0 0 150 100" xml:space="preserve">
<g>
<path fill="#003E6E" d="M114.12,19.546l-5.682,5.665c5.168,6.938,8.258,15.496,8.258,24.789c0,22.988-18.702,41.696-41.698,41.696
c-0.007,0-0.017,0-0.026,0c-0.013,0-0.018,0-0.037,0c-1.765,0-3.498-0.146-5.207-0.358c-0.333-0.047-0.652-0.104-0.99-0.152
c-1.551-0.236-3.082-0.546-4.574-0.944c-0.128-0.041-0.259-0.065-0.386-0.105c-1.861-0.52-3.668-1.163-5.407-1.924
c-6.742-2.92-12.49-7.607-16.812-13.43c-3.696-4.979-6.357-10.766-7.533-17.11c-0.027-0.121-0.039-0.257-0.063-0.388
c-0.192-1.112-0.369-2.229-0.472-3.367c-0.041-0.401-0.041-0.814-0.062-1.219c-0.052-0.88-0.133-1.753-0.133-2.653
c0-2.886,0.29-5.694,0.852-8.415c0.267-1.297,0.597-2.572,0.982-3.814c0.008-0.05,0.021-0.104,0.031-0.146
C40.437,20.677,56.3,8.302,74.998,8.302c2.794,0,5.487,0.372,8.114,0.916c0.135,0.032,0.27,0.056,0.407,0.086
c1.104,0.234,2.178,0.52,3.245,0.834c0.711,0.206,1.39,0.456,2.084,0.704c0.61,0.215,1.239,0.426,1.834,0.672
c0.264,0.105,0.513,0.248,0.772,0.362l8.751-4.627c-7.397-4.384-16.012-6.915-25.208-6.915C47.616,0.334,25.334,22.61,25.334,50
c0,11.488,3.958,22.048,10.535,30.474c3.834,4.911,8.568,9.073,13.951,12.258c7.396,4.375,15.988,6.934,25.177,6.934
c27.388,0,49.667-22.279,49.667-49.666C124.665,38.509,120.694,27.963,114.12,19.546z"/>
<g>
<path fill="#F6D000" d="M39.29,90.338c-0.553,0-1.161-0.386-1.372-0.898c-0.417-1.011,0.436-1.855,0.796-2.218L66.66,59.28
L46.717,47.535c-0.903-0.522-1.418-1.325-1.399-2.209c0.008-0.882,0.549-1.674,1.479-2.166l62.515-33.057
c0.593-0.309,1.008-0.443,1.402-0.443c0.548,0,1.157,0.383,1.367,0.892c0.419,1.011-0.404,1.825-0.792,2.219L83.403,40.653
l19.89,11.8c0.905,0.526,1.419,1.332,1.401,2.214c-0.018,0.882-0.563,1.666-1.487,2.158L40.683,89.893
C40.1,90.205,39.681,90.338,39.29,90.338z"/>
<path fill="#577BC6" d="M110.714,11.029c0.227,0,0.101,0.27-0.395,0.774L82.432,39.684c-0.796,0.796-0.642,1.909,0.32,2.467
l19.854,11.491c0.97,0.562,0.957,1.444-0.04,1.972L40.042,88.68c-0.364,0.196-0.616,0.284-0.751,0.284
c-0.225,0-0.113-0.267,0.391-0.767l27.948-27.949c0.794-0.793,0.647-1.903-0.328-2.455L47.407,46.345
c-0.976-0.559-0.961-1.445,0.031-1.972l62.516-33.057C110.319,11.122,110.572,11.029,110.714,11.029 M110.714,8.288L110.714,8.288
c-0.638,0-1.246,0.18-2.05,0.608L46.16,41.948c-1.37,0.723-2.196,1.98-2.219,3.357c-0.023,1.374,0.761,2.653,2.097,3.419
l18.565,10.679L37.74,86.256c-1.228,1.227-1.601,2.477-1.09,3.708c0.42,1.024,1.531,1.746,2.64,1.746
c0.629,0,1.241-0.181,2.041-0.606l62.519-33.065c1.358-0.719,2.183-1.972,2.21-3.346c0.032-1.372-0.746-2.654-2.079-3.424
L85.451,40.547l26.806-26.803c1.234-1.233,1.603-2.486,1.087-3.717C112.926,9.006,111.82,8.288,110.714,8.288L110.714,8.288z"/>
</g>
</g>
<g>
</g>
<g>
<path fill="#003E6E" d="M66.16,188.362l0.004-8.877c0,0.088,0,0.18,0,0.279L66.16,188.362z"/>
<path fill="#003E6E" d="M66.163,199.491c-0.007-0.004-0.013-1.137-0.011-2.52l0.008-8.609l-0.01,11.117L66.163,199.491z"/>
<path fill="#003E6E" d="M67.947,197.733c-0.977,0.975-1.778,1.768-1.784,1.758l0.011,0.016L67.947,197.733z"/>
</g>
</svg>
img/lsws_logo.svg 0000644 00000005260 15055121352 0010053 0 ustar 00 <?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="300px" height="300px" viewBox="0 0 300 300" enable-background="new 0 0 300 300" xml:space="preserve">
<g>
<path fill="#5E8CDA" d="M254.859,146.258l-68.508-68.516l-29.203,37.055l31.461,31.461c2.922,2.922,2.922,7.68,0,10.57
l-9.086,9.086c0,0,6.148,9.195,6.414,9.75c1.422,2.836,1.742,9.492-2.273,12.547l-71.57,54.969c0,18.422-0.016,56.336,0,56.344
c0.031,0,142.766-142.695,142.766-142.695C257.75,153.898,257.75,149.18,254.859,146.258z"/>
<path fill="#093071" d="M95.703,154.891c-2.898-2.875-2.898-7.641,0-10.531l9.109-9.125l-6.219-8.938
c-2.977-4.219-2.039-10.203,2.055-13.344l71.602-54.938l0.023-56.328l-0.023-0.031l-0.039-0.047L29.477,144.359
c-2.922,2.891-2.922,7.656,0,10.539l68.5,68.508l29.219-37.055L95.703,154.891z"/>
</g>
<path fill="#5E8CDA" d="M208.297,35.727c1.092,0,2.147,0.654,2.624,1.624c0.804,1.658-0.217,3.189-1.236,4.495l-0.04,0.051
l-62.727,79.64c-0.829,1.05-0.891,3.144-0.132,4.218c0.339,0.491,33.879,49.111,35.027,50.794c1.342,1.918,1.425,7.623-1.657,9.978
L79.348,263.915c-1.305,0.993-2.252,1.535-3.492,1.546c-0.99-0.082-2.015-0.756-2.44-1.601c-0.783-1.612,0.143-3.176,1.253-4.616
l62.727-79.607c0.83-1.114,0.908-3.081,0.152-4.231l-35.019-50.348c-2.308-3.283-1.585-7.943,1.611-10.39l100.851-77.445
C206.396,36.146,207.321,35.727,208.297,35.727 M208.297,34.727c-1.211,0-2.336,0.492-3.914,1.703l-100.852,77.445
c-3.625,2.773-4.445,8.023-1.82,11.758l35.016,50.344c0.508,0.773,0.438,2.297-0.133,3.063l-62.711,79.586
c-0.813,1.055-2.523,3.289-1.367,5.672c0.594,1.18,1.945,2.07,3.305,2.164c1.555,0,2.695-0.656,4.133-1.75l100.813-77.391
c3.508-2.68,3.523-8.977,1.867-11.344c-1.156-1.695-35.023-50.789-35.023-50.789c-0.508-0.719-0.461-2.328,0.094-3.031
l62.727-79.641c0.805-1.031,2.555-3.203,1.391-5.602C211.172,35.594,209.766,34.727,208.297,34.727L208.297,34.727z"/>
<path fill="#F5CD21" d="M178.992,176.898c0.82,1.25,1.563,5.867-0.477,7.422L77.641,261.75c-0.836,0.664-1.391,0.984-1.617,0.961
c-0.359,0.023-0.102-0.586,0.82-1.797l62.688-79.555c1.586-2.039,1.688-5.414,0.227-7.516l-34.977-50.367
C104.781,123.477,178.188,175.664,178.992,176.898z"/>
<path fill="#FDDD75" d="M178.992,176.898l-34.461-49.555c-1.438-2.125-1.336-5.492,0.242-7.508l62.695-79.578
c0.945-1.203,1.164-1.781,0.828-1.781c-0.227,0-0.805,0.281-1.625,0.945l-100.875,77.422c-2.016,1.555-2.477,4.547-1.016,6.633
L178.992,176.898z"/>
</svg>
img/attention.svg 0000644 00000002403 15055121352 0010044 0 ustar 00 <?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="12px" height="12px" viewBox="0 0 12 12" enable-background="new 0 0 12 12" xml:space="preserve">
<path fill="#F15A29" d="M6,0.5C2.967,0.5,0.5,2.967,0.5,6c0,3.032,2.467,5.5,5.5,5.5c3.032,0,5.5-2.468,5.5-5.5
C11.5,2.967,9.032,0.5,6,0.5z M6,10.5c-2.481,0-4.5-2.019-4.5-4.5S3.519,1.5,6,1.5s4.5,2.019,4.5,4.5S8.481,10.5,6,10.5z"/>
<g>
<path fill="#F15A29" d="M6.602,8.649c0,0.164-0.059,0.305-0.178,0.42C6.306,9.185,6.164,9.243,6,9.243S5.694,9.185,5.576,9.069
c-0.119-0.115-0.178-0.256-0.178-0.42s0.059-0.305,0.178-0.424C5.694,8.106,5.836,8.048,6,8.048s0.306,0.059,0.424,0.178
C6.543,8.345,6.602,8.485,6.602,8.649z M6.563,3.35c0,0.146-0.049,0.639-0.145,1.477C6.321,5.664,6.236,6.475,6.163,7.257H5.82
C5.756,6.475,5.676,5.664,5.58,4.826C5.485,3.988,5.438,3.496,5.438,3.35c0-0.167,0.053-0.308,0.158-0.422S5.836,2.757,6,2.757
s0.299,0.057,0.404,0.169C6.51,3.039,6.563,3.18,6.563,3.35z"/>
</g>
</svg>
img/web-adc_logo.svg 0000644 00000127716 15055121352 0010400 0 ustar 00 <?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="150px" height="75px" viewBox="0 0 150 75" enable-background="new 0 0 150 75" xml:space="preserve">
<g>
<g>
<path fill="#798193" d="M-119.062,379.44c0.113,0.113,0.23,0.221,0.346,0.328l-0.337-0.338l-0.338-0.338
C-119.283,379.21-119.176,379.325-119.062,379.44z"/>
<path fill="#798193" d="M-118.703,362.048l-0.017,0.018c-0.116,0.107-0.231,0.215-0.343,0.326s-0.218,0.227-0.324,0.342l0,0
l-8.175,8.174l8.174,8.174c0.11,0.117,0.22,0.236,0.334,0.35c0.115,0.115,0.232,0.225,0.351,0.336
c4.614,4.262,11.746,4.26,16.357-0.01l-0.018,0.018c0.119-0.109,0.236-0.219,0.351-0.334s0.225-0.232,0.334-0.352l0,0
c4.27-4.611,4.271-11.746,0.004-16.361l-0.675-0.674C-106.962,357.788-114.09,357.786-118.703,362.048z"/>
</g>
<path fill="#FFFFFF" d="M-99.822,376.427c-0.017-0.037-0.042-0.078-0.067-0.108c-0.048-0.057-0.092-0.118-0.137-0.178l-0.086-0.117
c-0.883-1.139-1.47-2.46-1.699-3.823c-0.005-0.03-0.013-0.059-0.024-0.087c-0.072-0.505-0.486-0.898-1.011-0.944
c-0.033-0.009-0.067-0.014-0.1-0.014c-0.025,0-0.052,0.003-0.078,0.008h-1.167c-0.026-0.005-0.052-0.008-0.077-0.008
c-0.545,0-1.003,0.418-1.078,0.976c-0.001,0.005-0.002,0.009-0.002,0.009c-0.7,2.215-2.706,3.693-4.994,3.693
c-2.903,0-5.266-2.362-5.266-5.267c0-2.905,2.363-5.269,5.266-5.269c2.348,0,4.367,1.532,5.021,3.813l0.013,0.049l0.009,0.036
c0.025,0.131,0.086,0.223,0.123,0.279l0.022,0.045c0.027,0.073,0.071,0.194,0.186,0.301c0.194,0.193,0.448,0.302,0.724,0.302
c0.018,0,0.037-0.001,0.055-0.004c0.472-0.026,0.851-0.355,0.978-0.848c0.009-0.035,0.014-0.071,0.014-0.107v-0.28v-0.152
c0-0.039-0.005-0.078-0.016-0.116c-0.28-1.001-0.759-1.919-1.423-2.727c-0.678-0.822-1.499-1.476-2.439-1.94
c-0.016-0.009-0.034-0.019-0.051-0.029c-0.044-0.026-0.089-0.051-0.137-0.072c-0.943-0.437-1.985-0.659-3.094-0.659
c-0.502,0-0.998,0.044-1.473,0.132c-3.434,0.714-5.919,3.767-5.919,7.26c0.008,3.505,2.496,6.551,5.917,7.258
c0.501,0.103,1.007,0.154,1.505,0.154c1.037,0,2.059-0.226,3.035-0.669c0.081-0.036,0.161-0.081,0.24-0.126
c0.036-0.02,0.071-0.04,0.107-0.06c0.327-0.173,0.708-0.386,1.066-0.665l0.067-0.059l0.041-0.035
c0.4-0.324,0.757-0.671,1.082-1.055c0.019-0.016,0.036-0.034,0.052-0.053c0.369-0.451,0.682-0.961,0.95-1.55
c0.386,1.356,1.033,2.635,1.893,3.729c0.028,0.036,0.052,0.068,0.076,0.101c0.041,0.053,0.081,0.106,0.125,0.158
c0.022,0.026,0.047,0.051,0.075,0.07c0.113,0.083,0.35,0.256,0.67,0.256c0.645,0,1.17-0.525,1.17-1.171
c0-0.186-0.078-0.32-0.125-0.4C-99.808,376.451-99.816,376.439-99.822,376.427z"/>
</g>
<g>
<path fill="#798193" d="M-74.215,362.729l-0.676-0.677l-8.178-8.178l-8.174,8.176c-0.118,0.107-0.235,0.219-0.351,0.332
c-0.115,0.116-0.225,0.234-0.334,0.352c-2.076,2.247-3.132,5.095-3.185,7.954v-0.259c-0.005,0.158-0.012,0.317-0.012,0.479
c0,0.16,0.005,0.317,0.012,0.476v-0.258c0.052,2.86,1.109,5.708,3.185,7.955l0.686,0.684c4.613,4.263,11.745,4.26,16.356-0.007
l0.667-0.668C-69.949,374.479-69.948,367.345-74.215,362.729z"/>
<g>
<path fill="#FFFFFF" d="M-74.86,376.427c-0.017-0.036-0.042-0.078-0.067-0.107c-0.048-0.057-0.091-0.116-0.134-0.176l-0.09-0.121
c-0.882-1.138-1.469-2.459-1.698-3.822c-0.003-0.021-0.008-0.039-0.014-0.058c-0.036-0.249-0.148-0.476-0.323-0.647
c-0.099-0.099-0.219-0.181-0.355-0.239c-0.021-0.009-0.048-0.018-0.074-0.023c-0.109-0.04-0.212-0.063-0.318-0.067
c-0.012-0.002-0.023-0.002-0.034-0.002c-0.019,0-0.191,0.002-0.398,0.07c-0.05,0.017-0.077,0.026-0.104,0.039
c-0.08,0.034-0.211,0.099-0.341,0.221c-0.176,0.165-0.289,0.376-0.347,0.647c-0.002,0.007-0.008,0.022-0.014,0.04l-0.023,0.069
c-0.138,0.444-0.354,0.883-0.639,1.303c-0.025,0.039-0.047,0.069-0.069,0.101l-0.034,0.046c-0.114,0.158-0.247,0.318-0.392,0.475
c-1.012,1.123-2.375,1.739-3.844,1.739c-2.173,0-4.13-1.39-4.87-3.457c-0.032-0.09-0.058-0.183-0.084-0.275
c-0.021-0.071-0.039-0.123-0.057-0.175c-0.02-0.058-0.04-0.113-0.053-0.173c-0.01-0.047-0.028-0.091-0.053-0.132
c-0.209-0.342-0.565-0.546-0.951-0.546c-0.558,0-1.022,0.408-1.104,0.971c-0.007,0.052-0.005,0.104,0.006,0.154
c0.04,0.182,0.087,0.361,0.14,0.538c0.085,0.287,0.192,0.576,0.317,0.86c0.064,0.146,0.134,0.288,0.207,0.43l0.064,0.126
c0.83,1.515,2.171,2.692,3.779,3.32c0.835,0.308,1.731,0.463,2.671,0.463c0.862,0,1.684-0.131,2.442-0.389
c0.032-0.01,0.068-0.022,0.104-0.036c0.156-0.056,0.319-0.126,0.481-0.199c0.134-0.061,0.263-0.12,0.388-0.187
c0.044-0.023,0.088-0.049,0.133-0.074l0.038-0.021c0.919-0.52,1.711-1.22,2.326-2.051c0.369,0.858,0.843,1.659,1.417,2.39
c0.027,0.033,0.05,0.064,0.073,0.095c0.042,0.056,0.083,0.11,0.129,0.164c0.021,0.025,0.046,0.049,0.073,0.068
c0.173,0.127,0.388,0.257,0.672,0.257c0.645,0,1.17-0.525,1.17-1.171c0-0.187-0.079-0.32-0.125-0.4
C-74.847,376.45-74.854,376.439-74.86,376.427z"/>
<path fill="#FFFFFF" d="M-90.334,370.149c0.531,0,0.97-0.379,1.077-0.926c0.048-0.14,0.326-0.859,0.475-1.134
c0.011-0.021,0.021-0.042,0.028-0.064c0.014-0.03,0.027-0.057,0.04-0.083c0.002-0.003,0.023-0.034,0.025-0.036
c0.009-0.012,0.017-0.023,0.024-0.035c0.957-1.583,2.618-2.527,4.443-2.527c2.291,0,4.283,1.487,4.958,3.701
c0.003,0.017,0.011,0.036,0.02,0.056c0.053,0.587,0.547,1.049,1.148,1.049c0.025,0,0.051-0.003,0.076-0.007
c0.522-0.038,0.952-0.433,1.041-0.961c0.003-0.023,0.006-0.047,0.006-0.071v-14.976v-0.338c0-0.011,0.001-0.02,0.001-0.03v-0.116
c0-0.049-0.009-0.099-0.025-0.146c-0.163-0.453-0.594-0.759-1.071-0.759c-0.51,0-0.948,0.336-1.089,0.835
c-0.01,0.038-0.016,0.077-0.016,0.117v0.384v11.161c-1.435-1.332-3.133-2.006-5.061-2.006c-2.068,0-3.841,0.724-5.269,2.151
c-0.904,0.901-1.521,1.993-1.837,3.246c-0.023,0.093-0.04,0.188-0.056,0.284l-0.021,0.119c-0.01,0.05-0.01,0.101-0.001,0.15
C-91.327,369.745-90.871,370.149-90.334,370.149z M-89.046,367.666L-89.046,367.666L-89.046,367.666L-89.046,367.666z"/>
</g>
</g>
<g>
<g>
<path fill="#798193" d="M-46.758,362.727c-0.108-0.114-0.214-0.23-0.326-0.341c-0.111-0.112-0.226-0.219-0.341-0.326
c-4.613-4.269-11.748-4.271-16.361-0.003l-0.676,0.676c-2.088,2.257-3.147,5.119-3.192,7.992v-0.304
c-0.007,0.161-0.013,0.322-0.013,0.485s0.005,0.323,0.013,0.482v-0.297c0.043,2.874,1.102,5.735,3.187,7.992l0.686,0.685
c2.222,2.054,5.032,3.108,7.859,3.181h-0.171c0.134,0.006,0.271,0.011,0.408,0.012c0.052-0.001,0.102-0.001,0.156-0.001
c0.134-0.002,0.27-0.005,0.403-0.01l-0.175-0.001c2.831-0.071,5.641-1.125,7.865-3.181l0.686-0.686l8.173-8.175L-46.758,362.727z"
/>
<path fill="#798193" d="M-64.469,362.729l0.677-0.676c-0.118,0.107-0.235,0.214-0.349,0.329
C-64.254,362.496-64.362,362.612-64.469,362.729z"/>
</g>
<g>
<path fill="#FFFFFF" d="M-49.902,372.64c-0.045-0.031-0.09-0.055-0.125-0.07c-0.026-0.014-0.054-0.025-0.083-0.033
c-0.122-0.043-0.248-0.066-0.375-0.066c-0.364,0-0.704,0.186-0.907,0.496c-0.01,0.016-0.02,0.033-0.028,0.051
c-0.038,0.078-0.076,0.156-0.118,0.238c-0.009,0.02-0.017,0.037-0.023,0.057c-0.004,0.014-0.017,0.045-0.051,0.104l-0.115,0.145
c-0.415,0.547-0.807,1.063-1.313,1.465c-0.513,0.406-1.128,0.684-1.829,0.824c-0.404,0.08-0.817,0.121-1.228,0.121
c-1.093,0-2.106-0.295-2.854-0.834c-0.63-0.453-1.234-1.148-1.658-1.904c-0.186-0.332-0.337-0.689-0.449-1.063l-0.022-0.066
c-0.058-0.283-0.216-0.531-0.449-0.703c-0.157-0.131-0.394-0.215-0.631-0.215c-0.13,0-0.254,0.023-0.368,0.072
c-0.168,0.057-0.313,0.145-0.409,0.252c-0.125,0.131-0.213,0.295-0.262,0.494c-0.021,0.063-0.041,0.135-0.039,0.232
c0,0.018,0.001,0.033,0.004,0.049c0.164,1.219,0.874,2.523,1.946,3.58c0.277,0.273,0.577,0.512,0.867,0.742
c0.604,0.439,1.212,0.77,1.82,0.99c0.603,0.293,1.433,0.438,2.535,0.438c1.101,0,1.929-0.145,2.532-0.438
c1.705-0.617,3.137-1.895,4.036-3.6c0.007-0.014,0.014-0.029,0.02-0.045C-49.289,373.47-49.475,372.915-49.902,372.64z"/>
<path fill="#FFFFFF" d="M-62.936,369.806c0.122,0.137,0.303,0.219,0.437,0.264c0.085,0.035,0.21,0.061,0.339,0.061
c0.238,0,0.475-0.084,0.65-0.23c0.213-0.156,0.371-0.404,0.429-0.688l0.016-0.047c0.118-0.393,0.269-0.752,0.455-1.084
c0.01-0.018,0.02-0.037,0.027-0.057c0.017-0.043,0.036-0.084,0.058-0.121c0.017-0.021,0.043-0.057,0.056-0.08
c0.758-1.518,2.444-2.459,4.402-2.459c1.957,0,3.644,0.941,4.401,2.459c0.012,0.023,0.027,0.047,0.043,0.068l0.188-0.111
c0.002,0.004,0.007,0.01,0.008,0.012c0.001,0.002,0.002,0.004,0.003,0.006l-0.172,0.127c0.018,0.033,0.03,0.064,0.035,0.078
c0.006,0.02,0.014,0.037,0.023,0.057c0.042,0.082,0.081,0.16,0.119,0.24c0.008,0.016,0.017,0.031,0.027,0.047
c0.204,0.313,0.543,0.498,0.907,0.498c0.132,0,0.263-0.025,0.389-0.072c0.003-0.002,0.007-0.002,0.01-0.004
c0.005-0.002,0.009-0.002,0.013-0.004c0.003-0.002,0.006-0.002,0.008-0.004c0.037-0.016,0.1-0.043,0.163-0.086
c0.428-0.275,0.613-0.826,0.423-1.313c-0.006-0.016-0.013-0.031-0.02-0.045c-0.898-1.705-2.331-2.982-4.036-3.6
c-0.603-0.293-1.431-0.438-2.532-0.438c-1.103,0-1.932,0.145-2.535,0.439c-0.607,0.219-1.215,0.549-1.806,0.977
c-0.326,0.24-0.63,0.502-0.906,0.777c-1.057,1.059-1.758,2.354-1.921,3.555c-0.002,0.018-0.003,0.033-0.004,0.049
c-0.002,0.105,0.02,0.182,0.042,0.242C-63.156,369.499-63.066,369.673-62.936,369.806z M-60.865,367.646L-60.865,367.646
L-60.865,367.646L-60.865,367.646z"/>
</g>
</g>
<line fill="none" stroke="#FFFFFF" stroke-width="0.3197" stroke-miterlimit="10" x1="238.334" y1="420.834" x2="255.386" y2="420.834"/>
<path fill="#57677C" d="M186.972,392.545c-0.066-0.073-0.136-0.146-0.206-0.218c-0.071-0.071-0.146-0.14-0.218-0.207
c-0.71-0.656-1.518-1.146-2.372-1.476c-0.093-0.035-0.188-0.063-0.279-0.095c-0.114-0.038-0.229-0.081-0.345-0.113
c-0.159-0.048-0.321-0.082-0.482-0.118c-0.051-0.012-0.102-0.025-0.153-0.035c-0.199-0.041-0.4-0.069-0.603-0.092
c-0.015-0.003-0.029-0.006-0.045-0.007c-0.217-0.023-0.436-0.036-0.653-0.04h0.157c-0.098-0.004-0.196-0.008-0.297-0.008
s-0.197,0.004-0.296,0.008h0.135c-1.771,0.034-3.532,0.689-4.925,1.979l-0.421,0.418l-5.073,5.074l5.072,5.072
c0.066,0.073,0.136,0.146,0.207,0.218c0.071,0.071,0.144,0.14,0.218,0.207c0.71,0.656,1.517,1.146,2.373,1.476
c0.091,0.035,0.184,0.063,0.276,0.095c0.115,0.039,0.229,0.081,0.346,0.113c0.159,0.048,0.321,0.083,0.482,0.119
c0.052,0.011,0.102,0.024,0.152,0.034c0.201,0.041,0.403,0.07,0.605,0.093c0.014,0.002,0.028,0.005,0.042,0.006
c0.217,0.023,0.436,0.036,0.654,0.04h-0.157c0.098,0.004,0.197,0.008,0.297,0.008s0.197-0.004,0.296-0.008h-0.136
c1.771-0.034,3.534-0.689,4.927-1.978l0.419-0.42l5.074-5.073L186.972,392.545z"/>
<g>
<path fill="#798193" d="M197.121,402.693c0.066,0.071,0.133,0.143,0.202,0.212s0.141,0.136,0.212,0.201
c2.863,2.648,7.29,2.651,10.151,0.002l0.42-0.419c1.295-1.4,1.952-3.176,1.979-4.959v0.188c0.005-0.1,0.008-0.2,0.008-0.301
c0-0.102-0.003-0.2-0.008-0.299v0.184c-0.026-1.783-0.683-3.559-1.978-4.959l-0.426-0.425c-1.378-1.274-3.121-1.929-4.876-1.974
h0.107c-0.084-0.004-0.169-0.007-0.253-0.008c-0.033,0.001-0.063,0.001-0.098,0.001c-0.084,0.002-0.167,0.003-0.25,0.006
l0.107,0.001c-1.756,0.044-3.499,0.698-4.88,1.974l-0.425,0.426l-5.072,5.072L197.121,402.693z"/>
<path fill="#798193" d="M208.109,402.691l-0.42,0.419c0.074-0.065,0.146-0.133,0.217-0.204
C207.977,402.836,208.044,402.765,208.109,402.691z"/>
</g>
<g>
<path fill="#798193" d="M165.621,392.322c-0.07-0.071-0.142-0.138-0.215-0.204l0.21,0.209l0.21,0.21
C165.759,392.465,165.692,392.394,165.621,392.322z"/>
<path fill="#798193" d="M165.399,403.113l0.009-0.011c0.074-0.066,0.145-0.134,0.215-0.202c0.067-0.069,0.135-0.141,0.2-0.213l0,0
l5.072-5.071l-5.072-5.071c-0.068-0.073-0.137-0.147-0.207-0.218c-0.072-0.071-0.145-0.14-0.217-0.208
c-2.863-2.645-7.288-2.643-10.15,0.007l0.012-0.012c-0.073,0.068-0.147,0.136-0.217,0.208c-0.072,0.071-0.141,0.144-0.209,0.218
l0,0c-2.648,2.861-2.648,7.288-0.002,10.151l0.419,0.418C158.114,405.756,162.536,405.758,165.399,403.113z"/>
</g>
<path fill="none" stroke="#57677C" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="M217.965,302.262
c-0.066-0.073-0.136-0.146-0.206-0.218c-0.071-0.071-0.146-0.14-0.218-0.207c-0.71-0.656-1.518-1.146-2.372-1.476
c-0.093-0.035-0.188-0.063-0.279-0.095c-0.114-0.038-0.229-0.081-0.345-0.113c-0.159-0.048-0.321-0.082-0.482-0.118
c-0.051-0.012-0.102-0.025-0.153-0.035c-0.199-0.041-0.4-0.069-0.603-0.092c-0.015-0.003-0.029-0.006-0.045-0.007
c-0.217-0.023-0.436-0.036-0.653-0.04h0.157c-0.098-0.004-0.196-0.008-0.297-0.008s-0.197,0.004-0.296,0.008h0.135
c-1.771,0.034-3.532,0.689-4.925,1.979l-0.421,0.418l-5.073,5.074l5.072,5.072c0.066,0.073,0.136,0.146,0.207,0.218
c0.071,0.071,0.144,0.14,0.218,0.207c0.71,0.656,1.517,1.146,2.373,1.476c0.091,0.035,0.184,0.063,0.276,0.095
c0.115,0.039,0.229,0.081,0.346,0.113c0.159,0.048,0.321,0.083,0.482,0.119c0.052,0.011,0.102,0.024,0.152,0.034
c0.201,0.041,0.403,0.07,0.605,0.093c0.014,0.002,0.028,0.005,0.042,0.006c0.217,0.023,0.436,0.036,0.654,0.04h-0.157
c0.098,0.004,0.197,0.008,0.297,0.008s0.197-0.004,0.296-0.008h-0.136c1.771-0.034,3.534-0.689,4.927-1.978l0.419-0.42l5.074-5.073
L217.965,302.262z"/>
<path fill="#57677C" d="M216.865,303.276c-0.054-0.059-0.109-0.117-0.166-0.175c-0.057-0.057-0.117-0.111-0.174-0.165
c-0.568-0.525-1.214-0.918-1.897-1.181c-0.074-0.028-0.149-0.05-0.224-0.076c-0.092-0.03-0.183-0.064-0.275-0.091
c-0.127-0.038-0.258-0.065-0.387-0.094c-0.04-0.01-0.08-0.021-0.122-0.028c-0.159-0.033-0.32-0.056-0.481-0.073
c-0.012-0.003-0.023-0.005-0.037-0.006c-0.173-0.019-0.348-0.029-0.521-0.032h0.125c-0.078-0.003-0.156-0.006-0.237-0.006
s-0.157,0.003-0.237,0.006h0.108c-1.417,0.027-2.825,0.552-3.94,1.583l-0.336,0.334l-4.059,4.06l4.058,4.058
c0.054,0.059,0.108,0.117,0.165,0.175c0.058,0.057,0.115,0.111,0.175,0.165c0.567,0.525,1.214,0.918,1.898,1.181
c0.073,0.028,0.147,0.05,0.222,0.076c0.092,0.031,0.184,0.064,0.275,0.091c0.128,0.038,0.258,0.066,0.387,0.095
c0.041,0.009,0.081,0.02,0.121,0.027c0.162,0.033,0.323,0.057,0.484,0.074c0.012,0.002,0.023,0.004,0.034,0.005
c0.173,0.019,0.349,0.029,0.523,0.032h-0.126c0.078,0.003,0.158,0.006,0.238,0.006c0.079,0,0.157-0.003,0.236-0.006h-0.109
c1.418-0.027,2.828-0.552,3.941-1.582l0.336-0.336l4.059-4.059L216.865,303.276z"/>
<g>
<path fill="none" stroke="#798193" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="M228.114,312.41
c0.066,0.071,0.133,0.143,0.202,0.212s0.141,0.136,0.212,0.201c2.863,2.648,7.29,2.651,10.151,0.002l0.42-0.419
c1.295-1.4,1.952-3.176,1.979-4.959v0.188c0.005-0.1,0.008-0.2,0.008-0.301c0-0.102-0.003-0.2-0.008-0.299v0.184
c-0.026-1.783-0.683-3.559-1.978-4.959l-0.426-0.425c-1.378-1.274-3.121-1.929-4.876-1.974h0.107
c-0.084-0.004-0.169-0.007-0.253-0.008c-0.033,0.001-0.063,0.001-0.098,0.001c-0.084,0.002-0.167,0.003-0.25,0.006l0.107,0.001
c-1.756,0.044-3.499,0.698-4.88,1.974l-0.425,0.426l-5.072,5.072L228.114,312.41z"/>
<path fill="none" stroke="#798193" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="M239.103,312.408
l-0.42,0.419c0.074-0.065,0.146-0.133,0.217-0.204C238.97,312.553,239.037,312.481,239.103,312.408z"/>
</g>
<g>
<path fill="#798193" d="M229.279,311.395c0.053,0.058,0.105,0.114,0.162,0.17c0.055,0.056,0.111,0.108,0.169,0.161
c2.29,2.118,5.832,2.121,8.121,0.001l0.336-0.335c1.036-1.12,1.562-2.541,1.583-3.967v0.15c0.004-0.08,0.007-0.16,0.007-0.24
c0-0.082-0.003-0.16-0.007-0.239v0.146c-0.021-1.427-0.545-2.847-1.582-3.967l-0.34-0.34c-1.103-1.02-2.497-1.543-3.9-1.579h0.086
c-0.068-0.003-0.136-0.006-0.203-0.006c-0.026,0-0.051,0-0.078,0c-0.066,0.002-0.133,0.003-0.199,0.005l0.086,0.001
c-1.405,0.035-2.8,0.559-3.904,1.579l-0.34,0.341l-4.059,4.058L229.279,311.395z"/>
<path fill="#798193" d="M238.07,311.394l-0.336,0.335c0.059-0.053,0.117-0.106,0.173-0.163S238.018,311.452,238.07,311.394z"/>
</g>
<g>
<path fill="none" stroke="#798193" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="M196.614,302.039
c-0.07-0.071-0.142-0.138-0.215-0.204l0.21,0.209l0.21,0.21C196.752,302.182,196.686,302.11,196.614,302.039z"/>
<path fill="none" stroke="#798193" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="M196.393,312.83
l0.009-0.011c0.074-0.066,0.145-0.134,0.215-0.202c0.067-0.069,0.135-0.141,0.2-0.213l0,0l5.072-5.071l-5.072-5.071
c-0.068-0.073-0.137-0.147-0.207-0.218c-0.072-0.071-0.145-0.14-0.217-0.208c-2.863-2.645-7.288-2.643-10.15,0.007l0.012-0.012
c-0.073,0.068-0.147,0.136-0.217,0.208c-0.072,0.071-0.141,0.144-0.209,0.218l0,0c-2.648,2.861-2.648,7.288-0.002,10.151
l0.419,0.418C189.107,315.473,193.529,315.475,196.393,312.83z"/>
</g>
<g>
<path fill="#798193" d="M195.678,303.098c-0.057-0.057-0.113-0.11-0.172-0.163l0.168,0.167l0.168,0.168
C195.787,303.212,195.734,303.155,195.678,303.098z"/>
<path fill="#798193" d="M195.5,311.73l0.007-0.009c0.06-0.053,0.116-0.106,0.172-0.161c0.054-0.056,0.108-0.112,0.16-0.171l0,0
l4.058-4.057l-4.058-4.057c-0.055-0.059-0.109-0.118-0.165-0.175c-0.059-0.057-0.116-0.111-0.174-0.166
c-2.291-2.116-5.83-2.114-8.121,0.005l0.01-0.009c-0.059,0.055-0.117,0.108-0.174,0.166s-0.111,0.115-0.166,0.175l0,0
c-2.119,2.289-2.119,5.83-0.002,8.121l0.335,0.334C189.672,313.845,193.209,313.847,195.5,311.73z"/>
</g>
<path fill="#D8AD28" d="M196.943,310.531c-0.027-0.031-0.053-0.066-0.078-0.102l-0.041-0.057c-0.479-0.615-0.795-1.328-0.918-2.063
c-0.002-0.014-0.006-0.027-0.012-0.041c-0.035-0.271-0.256-0.481-0.535-0.508c-0.02-0.006-0.038-0.008-0.058-0.008
c-0.015,0-0.028,0.002-0.043,0.004h-0.625c-0.015-0.002-0.028-0.004-0.043-0.004c-0.296,0-0.544,0.23-0.577,0.535
c-0.375,1.185-1.457,1.982-2.692,1.982c-1.566,0-2.841-1.275-2.841-2.842s1.274-2.841,2.841-2.841c1.267,0,2.355,0.826,2.709,2.057
c0.021,0.108,0.056,0.159,0.075,0.191c0.028,0.067,0.053,0.133,0.113,0.188c0.105,0.104,0.239,0.16,0.385,0.16
c0.012,0,0.024,0,0.037-0.003c0.242-0.017,0.445-0.193,0.513-0.45c0.005-0.019,0.007-0.037,0.007-0.057v-0.15v-0.083
c0-0.021-0.002-0.04-0.008-0.061c-0.15-0.54-0.408-1.032-0.766-1.466c-0.363-0.44-0.803-0.791-1.31-1.042
c-0.049-0.028-0.073-0.041-0.097-0.053c-0.51-0.236-1.071-0.356-1.668-0.356c-0.268,0-0.533,0.024-0.789,0.07
c-1.846,0.385-3.182,2.025-3.182,3.902c0.004,1.883,1.341,3.52,3.18,3.9c0.271,0.055,0.543,0.082,0.809,0.082
c0.557,0,1.105-0.121,1.631-0.359c0.043-0.018,0.083-0.041,0.125-0.064l0.061-0.033c0.189-0.102,0.388-0.213,0.574-0.359
l0.054-0.046c0.222-0.181,0.414-0.368,0.587-0.574c0.009-0.008,0.018-0.017,0.025-0.025c0.201-0.244,0.372-0.524,0.519-0.849
c0.208,0.736,0.557,1.43,1.022,2.021l0.037,0.049c0.022,0.031,0.045,0.06,0.068,0.089c0.012,0.015,0.025,0.026,0.041,0.036
c0.061,0.045,0.187,0.139,0.359,0.139c0.344,0,0.623-0.279,0.623-0.623c0-0.1-0.043-0.172-0.068-0.215
C196.979,310.586,196.957,310.549,196.943,310.531z"/>
<g>
<g>
<path fill="#D8AD28" d="M217.506,310.532c-0.025-0.03-0.049-0.063-0.072-0.096l-0.049-0.065c-0.475-0.613-0.791-1.326-0.916-2.06
c0-0.009-0.003-0.019-0.006-0.027c-0.018-0.134-0.078-0.256-0.172-0.349c-0.049-0.051-0.117-0.098-0.192-0.129
c-0.01-0.004-0.022-0.008-0.036-0.012c-0.057-0.021-0.109-0.031-0.164-0.035c-0.008,0-0.016-0.001-0.023-0.001
c-0.01,0-0.103,0.001-0.213,0.038c-0.006,0.002-0.043,0.015-0.048,0.018c-0.056,0.023-0.125,0.058-0.191,0.121
c-0.092,0.088-0.152,0.2-0.183,0.344c-0.002,0.002-0.02,0.057-0.02,0.059c-0.074,0.24-0.191,0.477-0.345,0.705l-0.053,0.074
c-0.065,0.091-0.136,0.177-0.214,0.26c-0.537,0.598-1.293,0.938-2.074,0.938c-1.172,0-2.228-0.75-2.626-1.865
c-0.016-0.044-0.028-0.087-0.041-0.131l-0.034-0.107c-0.011-0.031-0.022-0.062-0.029-0.096c-0.006-0.025-0.016-0.05-0.029-0.071
c-0.112-0.183-0.303-0.291-0.507-0.291c-0.296,0-0.543,0.217-0.587,0.518c-0.004,0.025-0.003,0.053,0.002,0.078
c0.021,0.098,0.047,0.195,0.075,0.291c0.045,0.151,0.101,0.303,0.169,0.463c0.037,0.08,0.074,0.156,0.113,0.23
c0.01,0.021,0.021,0.047,0.037,0.072c0.441,0.809,1.162,1.441,2.028,1.779c0.447,0.166,0.929,0.25,1.435,0.25
c0.465,0,0.906-0.07,1.313-0.209l0.049-0.018c0.09-0.031,0.18-0.069,0.266-0.107c0.072-0.033,0.141-0.067,0.209-0.103l0.055-0.03
c0.525-0.297,0.959-0.68,1.293-1.131c0.199,0.467,0.457,0.9,0.766,1.294l0.033,0.044c0.025,0.033,0.05,0.064,0.077,0.097
c0.011,0.013,0.022,0.024,0.036,0.033c0.092,0.069,0.205,0.138,0.359,0.138c0.344,0,0.624-0.279,0.624-0.623
c0-0.1-0.042-0.171-0.067-0.214C217.543,310.587,217.521,310.549,217.506,310.532z"/>
</g>
<g>
<path fill="#D8AD28" d="M209.218,307.201c0.289,0,0.526-0.211,0.577-0.512c0.011-0.027,0.17-0.443,0.254-0.594l-0.102-0.059
c0.004-0.006,0.009-0.018,0.012-0.023l0.11,0.03c0.001-0.001,0.022-0.04,0.022-0.04c0.535-0.881,1.432-1.391,2.416-1.391
c1.236,0,2.311,0.803,2.675,1.998c0.002,0.005,0.005,0.014,0.01,0.025c0.025,0.314,0.291,0.564,0.613,0.564
c0.013,0,0.026-0.002,0.038-0.004c0.279-0.021,0.509-0.231,0.557-0.512l0.003-8.098v-0.198v-0.063
c0-0.025-0.005-0.052-0.013-0.075c-0.086-0.243-0.316-0.406-0.57-0.406c-0.271,0-0.505,0.18-0.58,0.445
c-0.006,0.02-0.01,0.041-0.01,0.062v0.206v6.021c-0.773-0.723-1.688-1.088-2.729-1.088c-1.112,0-2.064,0.39-2.831,1.156
c-0.486,0.486-0.818,1.072-0.986,1.745c-0.015,0.052-0.023,0.108-0.033,0.165l-0.01,0.054c-0.004,0.026-0.004,0.052,0,0.077
C208.69,306.985,208.933,307.201,209.218,307.201z"/>
</g>
</g>
<g>
<path fill="#D8AD28" d="M236.836,308.558c-0.037-0.027-0.075-0.043-0.096-0.053c-0.003,0-0.006-0.002-0.008-0.002l0,0
c-0.008-0.003-0.015-0.006-0.022-0.008c-0.071-0.024-0.132-0.033-0.192-0.033c-0.193,0-0.373,0.099-0.482,0.264l-0.047,0.091
l-0.033,0.068c-0.014,0.038-0.023,0.056-0.038,0.08l-0.069,0.09c-0.221,0.29-0.431,0.565-0.7,0.779
c-0.276,0.221-0.608,0.37-0.988,0.446c-0.216,0.043-0.438,0.065-0.659,0.065c-0.59,0-1.139-0.16-1.543-0.451
c-0.338-0.243-0.664-0.618-0.893-1.025c-0.102-0.181-0.184-0.372-0.243-0.573c0-0.002-0.015-0.042-0.015-0.044
c-0.021-0.136-0.108-0.276-0.239-0.37c-0.08-0.067-0.206-0.111-0.333-0.111c-0.068,0-0.134,0.012-0.193,0.037
c-0.062,0.018-0.168,0.065-0.232,0.15c-0.053,0.049-0.104,0.145-0.131,0.26c-0.004,0.009-0.019,0.052-0.017,0.114
c0.09,0.678,0.472,1.378,1.048,1.944c0.135,0.135,0.28,0.253,0.436,0.378c0.003,0.003,0.033,0.026,0.037,0.03
c0.324,0.233,0.656,0.41,0.983,0.527c0.301,0.152,0.75,0.231,1.349,0.231c0.6,0,1.049-0.079,1.373-0.241
c0.896-0.318,1.672-1.006,2.157-1.929C237.152,308.999,237.057,308.704,236.836,308.558z"/>
<path fill="#D8AD28" d="M229.83,307.024c0.043,0.062,0.149,0.109,0.227,0.133c0.042,0.02,0.107,0.032,0.178,0.032
c0.127,0,0.252-0.045,0.346-0.122c0.118-0.084,0.205-0.225,0.232-0.387c0.068-0.219,0.15-0.41,0.252-0.59
c0.023-0.057,0.031-0.074,0.043-0.092c0.003-0.006,0.027-0.042,0.031-0.049c0.408-0.817,1.319-1.325,2.375-1.325
c1.055,0,1.966,0.508,2.375,1.325c0.006,0.016,0.025,0.041,0.035,0.054c0.008,0.015,0.018,0.032,0.02,0.04l0.045,0.099l0.031,0.065
c0.125,0.19,0.305,0.289,0.498,0.289c0.072,0,0.145-0.014,0.213-0.039v-0.002h0.002l0,0c0.002,0,0.005-0.002,0.008-0.002
c0.008-0.004,0.02-0.008,0.03-0.014c0.043-0.014,0.081-0.04,0.108-0.074c0.195-0.16,0.268-0.42,0.176-0.656
c-0.495-0.944-1.27-1.634-2.192-1.963c-0.3-0.152-0.749-0.231-1.349-0.231c-0.599,0-1.048,0.079-1.374,0.241
c-0.306,0.107-0.636,0.286-0.959,0.521c-0.181,0.132-0.339,0.268-0.485,0.417c-0.568,0.567-0.944,1.263-1.032,1.907
c-0.004,0.088,0.013,0.135,0.019,0.154C229.704,306.855,229.756,306.951,229.83,307.024z"/>
</g>
<path fill="none" stroke="#57677C" stroke-width="1.0993" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="
M151.839,380.018c-0.077-0.076-0.157-0.151-0.238-0.228c-0.083-0.074-0.17-0.146-0.253-0.217c-0.823-0.683-1.758-1.194-2.748-1.538
c-0.108-0.037-0.218-0.064-0.324-0.099c-0.132-0.04-0.264-0.084-0.399-0.117c-0.185-0.051-0.372-0.086-0.56-0.124
c-0.058-0.013-0.116-0.026-0.177-0.036c-0.23-0.044-0.464-0.073-0.698-0.096c-0.017-0.004-0.034-0.006-0.053-0.008
c-0.251-0.024-0.504-0.038-0.757-0.042h0.183c-0.112-0.004-0.227-0.008-0.344-0.008s-0.229,0.004-0.343,0.008h0.155
c-2.052,0.036-4.092,0.72-5.706,2.064l-0.487,0.435l-5.879,5.292l5.878,5.29c0.077,0.076,0.157,0.152,0.24,0.228
c0.082,0.073,0.166,0.145,0.251,0.217c0.823,0.683,1.758,1.194,2.75,1.537c0.106,0.038,0.213,0.065,0.321,0.099
c0.133,0.041,0.265,0.085,0.4,0.119c0.185,0.05,0.372,0.087,0.56,0.123c0.059,0.012,0.116,0.026,0.176,0.036
c0.232,0.043,0.467,0.073,0.701,0.097c0.016,0.002,0.032,0.005,0.049,0.007c0.251,0.024,0.505,0.037,0.759,0.041h-0.183
c0.112,0.005,0.229,0.009,0.344,0.009s0.229-0.004,0.343-0.009h-0.157c2.054-0.035,4.096-0.719,5.709-2.063l0.485-0.438l5.88-5.29
L151.839,380.018z"/>
<path fill="#798193" d="M150.565,381.076c-0.063-0.062-0.128-0.123-0.192-0.183c-0.065-0.06-0.136-0.116-0.201-0.173
c-0.659-0.548-1.407-0.957-2.199-1.23c-0.086-0.03-0.174-0.053-0.259-0.08c-0.106-0.031-0.212-0.066-0.319-0.095
c-0.147-0.039-0.299-0.067-0.447-0.098c-0.047-0.01-0.094-0.021-0.143-0.029c-0.185-0.035-0.371-0.058-0.558-0.076
c-0.014-0.003-0.027-0.006-0.043-0.006c-0.2-0.021-0.403-0.031-0.604-0.035h0.146c-0.092-0.002-0.183-0.005-0.275-0.005
c-0.095,0-0.182,0.003-0.275,0.005h0.126c-1.642,0.029-3.273,0.576-4.566,1.652l-0.389,0.349l-4.703,4.232l4.702,4.231
c0.062,0.061,0.125,0.123,0.19,0.182c0.067,0.061,0.134,0.116,0.203,0.173c0.657,0.548,1.406,0.958,2.2,1.231
c0.084,0.029,0.171,0.052,0.256,0.08c0.106,0.032,0.214,0.065,0.319,0.094c0.148,0.04,0.299,0.069,0.447,0.1
c0.049,0.009,0.096,0.02,0.142,0.028c0.188,0.034,0.374,0.059,0.562,0.077c0.014,0.002,0.027,0.004,0.039,0.004
c0.2,0.021,0.404,0.032,0.606,0.035h-0.146c0.092,0.003,0.184,0.006,0.277,0.006c0.091,0,0.182-0.003,0.273-0.006h-0.127
c1.643-0.029,3.277-0.575,4.567-1.65l0.389-0.35l4.703-4.232L150.565,381.076z"/>
<path fill="#FFCB05" stroke="#FFFFFF" stroke-width="0.25" stroke-miterlimit="10" d="M214.709,303.664
c0.031-0.041,0.04-0.062,0.027-0.062c-0.008,0-0.027,0.01-0.055,0.032l-3.467,2.66c-0.069,0.054-0.086,0.156-0.035,0.229l1.203,1.73
c0.051,0.071,0.046,0.187-0.008,0.257l-2.154,2.734c-0.032,0.041-0.04,0.063-0.028,0.062c0.009,0.001,0.027-0.01,0.056-0.033
l3.466-2.659c0.07-0.055,0.017-0.256,0.017-0.256l-1.185-1.703c-0.05-0.072-0.046-0.188,0.008-0.258L214.709,303.664z"/>
<g>
<g>
<path fill="none" stroke="#D8AD28" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="M-103.157-432.77
c-0.171-0.188-0.349-0.374-0.53-0.56c-0.183-0.184-0.376-0.359-0.56-0.532c-1.824-1.687-3.9-2.946-6.096-3.792
c-0.238-0.09-0.482-0.161-0.718-0.244c-0.293-0.098-0.587-0.208-0.886-0.291c-0.409-0.123-0.826-0.211-1.24-0.304
c-0.131-0.03-0.261-0.065-0.394-0.09c-0.512-0.105-1.029-0.178-1.549-0.236c-0.038-0.007-0.075-0.015-0.115-0.018
c-0.557-0.06-1.119-0.093-1.679-0.103h0.404c-0.251-0.01-0.504-0.02-0.763-0.02c-0.259,0-0.507,0.01-0.761,0.02h0.347
c-4.553,0.088-9.078,1.772-12.656,5.084l-1.082,1.074l-13.038,13.04l13.035,13.035c0.17,0.188,0.349,0.374,0.532,0.56
c0.184,0.183,0.369,0.359,0.56,0.532c1.824,1.687,3.897,2.946,6.098,3.792c0.233,0.09,0.472,0.161,0.71,0.244
c0.296,0.1,0.59,0.208,0.889,0.291c0.409,0.123,0.826,0.213,1.24,0.306c0.133,0.028,0.261,0.063,0.392,0.088
c0.517,0.105,1.036,0.181,1.556,0.238c0.035,0.005,0.073,0.013,0.108,0.015c0.557,0.06,1.12,0.093,1.682,0.103h-0.404
c0.251,0.01,0.507,0.02,0.763,0.02s0.507-0.01,0.76-0.02h-0.349c4.552-0.088,9.082-1.772,12.661-5.082l1.077-1.079l13.041-13.038
L-103.157-432.77z"/>
<path fill="#D8AD28" d="M-105.983-430.162c-0.138-0.15-0.281-0.301-0.426-0.449c-0.146-0.146-0.301-0.286-0.447-0.424
c-1.46-1.35-3.12-2.359-4.876-3.034c-0.19-0.073-0.384-0.128-0.575-0.196c-0.236-0.078-0.469-0.166-0.708-0.233
c-0.326-0.098-0.663-0.168-0.994-0.241c-0.103-0.025-0.206-0.053-0.314-0.073c-0.409-0.085-0.823-0.143-1.237-0.188
c-0.03-0.007-0.06-0.012-0.095-0.015c-0.444-0.048-0.894-0.075-1.34-0.083h0.321c-0.201-0.007-0.401-0.015-0.61-0.015
c-0.208,0-0.404,0.008-0.61,0.015h0.279c-3.642,0.07-7.26,1.418-10.126,4.068l-0.863,0.858l-10.43,10.433l10.427,10.427
c0.138,0.151,0.279,0.301,0.424,0.449c0.148,0.146,0.296,0.286,0.449,0.424c1.458,1.35,3.119,2.359,4.878,3.034
c0.188,0.073,0.379,0.128,0.57,0.196c0.236,0.08,0.472,0.166,0.708,0.233c0.329,0.098,0.663,0.17,0.994,0.243
c0.105,0.022,0.208,0.05,0.311,0.07c0.417,0.085,0.831,0.146,1.245,0.191c0.03,0.005,0.061,0.01,0.088,0.012
c0.444,0.048,0.896,0.076,1.345,0.083h-0.324c0.201,0.008,0.407,0.015,0.612,0.015c0.203,0,0.404-0.007,0.607-0.015h-0.281
c3.644-0.07,7.268-1.418,10.129-4.065l0.863-0.863l10.43-10.43L-105.983-430.162z"/>
<path fill="#57677C" d="M-104.216-411.325c-0.025-0.05-0.083-0.148-0.121-0.19c-0.065-0.078-0.125-0.163-0.186-0.246l-0.125-0.168
c-1.22-1.576-2.033-3.408-2.354-5.293c0-0.022-0.008-0.048-0.015-0.07c-0.01-0.078-0.045-0.146-0.065-0.218
c-0.073-0.253-0.19-0.492-0.376-0.678c-0.125-0.13-0.301-0.251-0.494-0.331c-0.025-0.01-0.058-0.02-0.093-0.03
c-0.146-0.053-0.281-0.08-0.422-0.09c-0.02,0-0.04-0.002-0.06-0.002c-0.025,0-0.264,0.002-0.547,0.098
c-0.015,0.005-0.11,0.038-0.123,0.045c-0.143,0.06-0.321,0.148-0.492,0.311c-0.068,0.065-0.08,0.176-0.133,0.251
c-0.658,3.483-3.707,6.124-7.383,6.124c-3.805,0-6.919-2.838-7.418-6.505c-0.045-0.336-0.103-0.667-0.103-1.017
c0-0.404,0.058-0.793,0.118-1.179c0.146-0.909,0.454-1.754,0.893-2.525c0.015-0.025,0.025-0.05,0.041-0.073
c1.305-2.231,3.699-3.747,6.47-3.747c3.747,0,6.829,2.745,7.403,6.332c0.286,0.276,0.67,0.452,1.097,0.452
c0.033,0,0.068-0.005,0.098-0.01c0.718-0.053,1.308-0.595,1.431-1.315v-0.236l0.007-20.574v-0.509v-0.161
c0-0.065-0.012-0.133-0.032-0.193c-0.221-0.625-0.813-1.044-1.466-1.044c-0.698,0-1.297,0.462-1.491,1.145
c-0.015,0.05-0.025,0.105-0.025,0.158v0.529v15.441c-1.842-1.724-4.299-2.798-7.022-2.798c-1.125,0-2.184,0.223-3.197,0.557
c-0.906,0.286-1.772,0.66-2.563,1.202c-0.529,0.361-1.034,0.773-1.508,1.247c-0.058,0.058-0.103,0.123-0.158,0.181
c-0.316,0.329-0.6,0.685-0.868,1.052c-0.17,0.238-0.333,0.477-0.479,0.728c-0.058,0.093-0.103,0.193-0.155,0.289
c-0.851,1.499-1.375,3.205-1.375,5.052c0,5.692,4.613,10.305,10.305,10.305c3.42,0,6.427-1.684,8.302-4.246
c0.512,1.189,1.169,2.299,1.958,3.302l0.085,0.113c0.065,0.085,0.128,0.166,0.198,0.249c0.027,0.032,0.058,0.063,0.093,0.085
c0.236,0.178,0.527,0.354,0.923,0.354c0.883,0,1.604-0.718,1.604-1.601C-104.043-411.031-104.151-411.215-104.216-411.325z"/>
<path fill="#FFCB05" stroke="#FCF8EF" stroke-width="0.6425" stroke-miterlimit="10" d="M-111.999-429.168
c0.08-0.105,0.103-0.158,0.07-0.158c-0.021,0-0.07,0.025-0.141,0.083l-8.909,6.836c-0.178,0.138-0.221,0.402-0.09,0.587
l3.092,4.447c0.13,0.183,0.118,0.479-0.02,0.66l-5.536,7.027c-0.083,0.105-0.103,0.161-0.073,0.158
c0.022,0.002,0.07-0.025,0.143-0.085l8.906-6.834c0.181-0.141,0.043-0.657,0.043-0.657l-3.044-4.377
c-0.128-0.186-0.118-0.482,0.02-0.663L-111.999-429.168z"/>
</g>
<path fill="none" stroke="#EAD090" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="M-77.292-406.685
c0.171,0.183,0.342,0.366,0.52,0.544c0.179,0.178,0.361,0.349,0.545,0.517c7.358,6.806,18.734,6.813,26.087,0.005l1.079-1.077
c3.328-3.599,5.018-8.161,5.088-12.744v0.484c0.012-0.256,0.02-0.515,0.02-0.773c0-0.261-0.008-0.515-0.02-0.768v0.472
c-0.068-4.583-1.755-9.145-5.082-12.744l-1.095-1.092c-3.541-3.275-8.021-4.957-12.53-5.072h0.276
c-0.216-0.01-0.435-0.018-0.65-0.02c-0.085,0.002-0.163,0.002-0.251,0.002c-0.216,0.005-0.429,0.007-0.643,0.015l0.276,0.002
c-4.513,0.113-8.992,1.794-12.541,5.072l-1.091,1.094l-13.035,13.035L-77.292-406.685z"/>
<g>
<path fill="#EAD090" d="M-74.298-409.295c0.136,0.148,0.271,0.294,0.417,0.437c0.141,0.143,0.286,0.278,0.434,0.414
c5.886,5.443,14.987,5.451,20.87,0.002l0.863-0.861c2.663-2.878,4.013-6.53,4.068-10.194v0.386
c0.01-0.206,0.018-0.412,0.018-0.617c0-0.211-0.008-0.412-0.018-0.615v0.376c-0.053-3.667-1.4-7.315-4.065-10.194l-0.874-0.874
c-2.833-2.62-6.417-3.965-10.023-4.058h0.222c-0.176-0.008-0.35-0.015-0.522-0.015c-0.067,0-0.131,0-0.2,0
c-0.171,0.005-0.342,0.007-0.513,0.012l0.221,0.003c-3.611,0.09-7.194,1.435-10.033,4.058l-0.873,0.876l-10.431,10.428
L-74.298-409.295z"/>
<path fill="#EAD090" d="M-51.706-409.297l-0.863,0.861c0.15-0.136,0.301-0.273,0.444-0.419
C-51.982-409.001-51.842-409.146-51.706-409.297z"/>
</g>
<path fill="#57677C" d="M-73.272-417.062c0.024,0.201,0.095,0.401,0.141,0.602c0.11,0.382,0.2,0.773,0.354,1.14
c0.01,0.025,0.022,0.05,0.032,0.075c0.249,0.577,0.545,1.119,0.889,1.636c0.025,0.035,0.048,0.075,0.075,0.116
c0.324,0.472,0.695,0.908,1.09,1.32c0.05,0.055,0.088,0.11,0.138,0.161c0.072,0.07,0.155,0.13,0.229,0.196
c0.374,0.356,0.768,0.688,1.189,0.984c0.118,0.08,0.243,0.146,0.366,0.226c0.43,0.271,0.873,0.522,1.343,0.733
c0.085,0.035,0.171,0.075,0.259,0.11c1.204,0.497,2.521,0.778,3.904,0.783c0.016,0,0.028-0.005,0.043-0.005
c1.333-0.005,2.598-0.276,3.765-0.743c0.243-0.095,0.479-0.221,0.715-0.341c0.334-0.161,0.66-0.326,0.974-0.527
c0.309-0.196,0.61-0.422,0.901-0.663c0.165-0.13,0.334-0.261,0.489-0.407c0.409-0.371,0.793-0.778,1.146-1.225
c0.021-0.025,0.043-0.05,0.065-0.085c0.377-0.477,0.713-1.009,1.014-1.566c0.018-0.03,0.035-0.065,0.053-0.1
c0.264-0.703,0.022-1.461-0.547-1.832c-0.096-0.075-0.193-0.116-0.246-0.141c-0.01,0-0.018-0.005-0.022-0.005
c-0.02-0.005-0.037-0.015-0.058-0.021c-0.186-0.06-0.341-0.085-0.499-0.085c-0.304,0-0.577,0.12-0.826,0.291
c-0.077,0.19-0.183,0.364-0.276,0.544c-0.095,0.191-0.19,0.379-0.301,0.557c-0.131,0.211-0.273,0.409-0.424,0.605
c-0.096,0.125-0.196,0.246-0.299,0.366c-0.178,0.206-0.358,0.407-0.558,0.59c-0.037,0.035-0.077,0.063-0.115,0.098
c-0.481,0.429-1.019,0.793-1.599,1.089c-0.045,0.022-0.085,0.048-0.13,0.07c-0.289,0.138-0.585,0.251-0.892,0.354
c-0.08,0.027-0.16,0.05-0.24,0.075c-0.681,0.201-1.386,0.344-2.134,0.344c-4.158,0-7.528-3.373-7.528-7.534
c0-0.008,0.002-0.015,0.002-0.025l0,0c0-0.441,0.058-0.873,0.128-1.29c0-0.005,0.003-0.008,0.003-0.013
c0.056-0.306,0.146-0.595,0.236-0.889c0.053-0.166,0.093-0.333,0.155-0.497c0.085-0.221,0.193-0.432,0.299-0.643
c0.11-0.223,0.223-0.442,0.354-0.652c0.096-0.148,0.195-0.289,0.299-0.429c0.19-0.264,0.396-0.512,0.617-0.748
c0.075-0.078,0.148-0.156,0.226-0.231c0.299-0.289,0.617-0.552,0.962-0.791c0.022-0.015,0.042-0.033,0.063-0.045
c1.199-0.816,2.63-1.313,4.19-1.313c2.596,0,4.859,1.328,6.209,3.323c0.018,0.022,0.033,0.045,0.048,0.067
c0.278,0.424,0.534,0.866,0.726,1.343c0.248,0.171,0.515,0.281,0.806,0.281c0.188,0,0.374-0.035,0.552-0.101v-0.01h0.005
c0.005,0,0.013-0.005,0.022-0.005c0.021-0.01,0.051-0.02,0.078-0.035c0.11-0.035,0.208-0.101,0.281-0.191
c0.507-0.417,0.692-1.089,0.456-1.702c-0.64-1.22-1.46-2.273-2.416-3.132c-0.018-0.015-0.035-0.028-0.053-0.043
c-0.43-0.381-0.894-0.718-1.376-1.016c-0.157-0.095-0.326-0.176-0.489-0.264c-0.386-0.213-0.78-0.409-1.191-0.567
c-0.858-0.326-1.774-0.52-2.726-0.605c-0.319-0.022-0.585-0.07-0.943-0.07c-0.131,0-0.244,0.01-0.369,0.013
c-1.192,0.042-2.332,0.278-3.388,0.695c-0.211,0.083-0.427,0.184-0.646,0.292c-0.278,0.133-0.545,0.284-0.808,0.439
c-0.274,0.163-0.548,0.324-0.821,0.522c-0.06,0.045-0.112,0.098-0.173,0.143c-0.404,0.304-0.78,0.612-1.114,0.959
c-0.153,0.153-0.281,0.323-0.422,0.484c-0.238,0.274-0.484,0.54-0.692,0.838c-0.091,0.136-0.179,0.271-0.259,0.407
c-0.278,0.437-0.532,0.888-0.742,1.368c-0.033,0.07-0.065,0.143-0.094,0.213c-0.138,0.339-0.223,0.7-0.328,1.054
c-0.053,0.196-0.115,0.397-0.141,0.585c0,0.005,0,0.005,0,0.01c-0.065,0.268-0.115,0.542-0.166,0.815
c-0.067,0.474-0.143,0.949-0.146,1.443c0,0.03,0.008,0.06,0.008,0.09c0.005,0.437,0.072,0.856,0.131,1.277
c0.047,0.284,0.1,0.567,0.168,0.846C-73.272-417.067-73.272-417.067-73.272-417.062z"/>
<path fill="none" stroke="#EAD090" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" d="M-158.381-405.605
l0.022-0.028c0.191-0.17,0.372-0.344,0.552-0.52c0.173-0.178,0.346-0.361,0.515-0.547l0,0l13.035-13.033l-5.675-5.674l-7.36-7.358
c-0.176-0.188-0.352-0.379-0.532-0.56c-0.186-0.183-0.371-0.359-0.557-0.535c-7.358-6.796-18.729-6.791-26.085,0.018l0.03-0.03
c-0.188,0.176-0.379,0.349-0.557,0.535c-0.186,0.183-0.361,0.369-0.537,0.56l0,0c-6.806,7.354-6.806,18.729-0.005,26.087
l1.077,1.074C-177.103-398.814-165.739-398.81-158.381-405.605z"/>
<g>
<path fill="#EAD090" d="M-160.075-430.616c-0.146-0.146-0.291-0.284-0.442-0.419l0.432,0.429l0.432,0.432
C-159.794-430.323-159.93-430.468-160.075-430.616z"/>
<path fill="#EAD090" d="M-160.532-408.432l0.018-0.022c0.153-0.136,0.299-0.273,0.442-0.414c0.138-0.143,0.279-0.289,0.412-0.439
l0,0l10.427-10.425l-10.427-10.425c-0.141-0.15-0.281-0.304-0.424-0.449c-0.15-0.146-0.298-0.286-0.447-0.427
c-5.887-5.438-14.982-5.433-20.87,0.013l0.025-0.022c-0.15,0.141-0.301,0.278-0.447,0.427c-0.146,0.148-0.286,0.296-0.426,0.449
l0,0c-5.446,5.882-5.446,14.982-0.005,20.87l0.861,0.858C-175.509-402.998-166.419-402.993-160.532-408.432z"/>
</g>
<path fill="#57677C" d="M-157.066-411.328c-0.022-0.05-0.08-0.146-0.115-0.191c-0.07-0.08-0.136-0.17-0.201-0.261l-0.105-0.146
c-0.042-0.055-0.078-0.118-0.121-0.176c-1.132-1.313-1.895-2.931-2.146-4.733c-0.028-0.131-0.07-0.259-0.093-0.392
c-0.005-0.035-0.015-0.07-0.03-0.105c-0.09-0.695-0.658-1.237-1.375-1.305c-0.05-0.015-0.098-0.02-0.148-0.02
c-0.038,0-0.073,0.005-0.11,0.01l-0.66-0.002c-0.038-0.005-0.073-0.01-0.11-0.01c-0.502,0-0.931,0.271-1.205,0.673
c-0.454,2.135-1.854,3.897-3.727,4.898c-0.078,0.045-0.153,0.088-0.233,0.128c-0.236,0.116-0.475,0.216-0.723,0.306
c-0.206,0.076-0.414,0.136-0.625,0.193c-0.181,0.048-0.359,0.101-0.547,0.136c-0.437,0.08-0.883,0.135-1.343,0.135
c-4.025,0-7.3-3.277-7.3-7.303c0-0.51,0.055-1.009,0.156-1.488c0.675-3.348,3.631-5.87,7.18-5.87c3.579,0,6.548,2.565,7.193,5.956
c0.055,0.128,0.1,0.256,0.218,0.364c0.271,0.266,0.615,0.412,0.989,0.412c0.03,0,0.063,0,0.095-0.008
c0.623-0.042,1.145-0.497,1.318-1.157c0.012-0.048,0.018-0.095,0.018-0.146v-0.387v-0.213c0-0.053-0.005-0.103-0.021-0.156
c-0.386-1.388-1.049-2.653-1.967-3.767c-0.934-1.132-2.063-2.033-3.365-2.678c-0.125-0.073-0.188-0.105-0.249-0.135
c-1.31-0.607-2.753-0.916-4.287-0.916c-0.688,0-1.37,0.063-2.028,0.181c-4.743,0.989-8.176,5.205-8.176,10.028
c0.01,4.838,3.446,9.044,8.171,10.023c0.695,0.141,1.396,0.21,2.078,0.21c1.43,0,2.841-0.311,4.191-0.923
c0.11-0.045,0.213-0.105,0.321-0.166l0.156-0.085c0.487-0.261,0.996-0.547,1.476-0.923l0.138-0.118
c0.57-0.464,1.064-0.946,1.508-1.476c0.023-0.02,0.045-0.042,0.065-0.065c0.517-0.627,0.808-1.187,0.861-1.513
c0.535,1.892,1.579,3.599,2.374,4.447l0.095,0.125c0.058,0.08,0.116,0.153,0.176,0.228c0.03,0.038,0.065,0.068,0.105,0.093
c0.156,0.115,0.647,0.454,1.082,0.356c0.726-0.163,1.222-0.635,1.222-1.518C-156.891-411.031-157.001-411.217-157.066-411.328z"/>
</g>
<rect x="-26.146" y="-434.683" fill="none" width="351.479" height="27.581"/>
<text transform="matrix(1 0 0 1 -26.1465 -408.043)" fill="#657185" stroke="#657185" stroke-width="0.25" stroke-miterlimit="10" font-family="'GeosansLight'" font-size="36">LiteSpeed</text>
<text transform="matrix(1 0 0 1 110.3623 -408.043)" fill="#4B5265" font-family="'GeosansLight'" font-size="36"> </text>
<text transform="matrix(1 0 0 1 119.542 -408.043)" fill="#595D6F" stroke="#4B5265" stroke-width="0.5" stroke-miterlimit="10" font-family="'GeosansLight'" font-size="36">Web </text>
<text transform="matrix(1.25 0 0 1 196.5098 -408.043)" fill="#595D6F" stroke="#4B5265" stroke-width="0.5" stroke-miterlimit="10" font-family="'GeosansLight'" font-size="36">A</text>
<text transform="matrix(1.1 0 0 1 224.9941 -408.043)" fill="#595D6F" stroke="#4B5265" stroke-width="0.5" stroke-miterlimit="10" font-family="'GeosansLight'" font-size="36">D</text>
<text transform="matrix(1 0 0 1 252.2383 -408.043)" fill="#595D6F" stroke="#4B5265" stroke-width="0.5" stroke-miterlimit="10" font-family="'GeosansLight'" font-size="36">C</text>
<g>
<g>
<path fill="#003B71" d="M92.615,44.693L80.153,57.156c-1.378,1.378-3.21,2.138-5.158,2.14h-0.007c-1.95,0-3.785-0.76-5.167-2.14
L31.927,19.258c-1.005-1.003-2.336-1.554-3.751-1.554c-1.417,0-2.75,0.552-3.752,1.555l-14.49,14.49
c-1.001,1-1.553,2.333-1.553,3.751s0.552,2.751,1.554,3.752l14.489,14.49c0.977,0.974,2.343,1.531,3.752,1.531
c1.41,0,2.777-0.558,3.75-1.53L44.38,43.289l-2.122-2.122L29.806,53.621c-0.871,0.87-2.39,0.869-3.261,0L12.055,39.13
c-0.899-0.898-0.899-2.361,0-3.26l14.49-14.49c0.436-0.436,1.015-0.676,1.631-0.676c0.615,0,1.194,0.24,1.63,0.675l37.896,37.899
c1.947,1.945,4.534,3.018,7.287,3.018c0.003,0,0.006,0,0.01,0c2.749-0.003,5.332-1.074,7.276-3.019l12.462-12.463L92.615,44.693z"
/>
<path fill="#003B71" d="M28.176,59.296c-1.951,0-3.785-0.76-5.166-2.14L8.52,42.665c-1.377-1.377-2.135-3.211-2.135-5.165
s0.758-3.788,2.134-5.165L23.01,17.844c1.38-1.38,3.215-2.14,5.166-2.14s3.785,0.76,5.165,2.14l23.192,23.134l-0.185-0.225
c0.546,0.594,2.883,2.939,14.884,14.985c0.979,0.978,2.346,1.534,3.757,1.534c1.449,0,2.782-0.543,3.769-1.53l12.453-12.453
l-2.121-2.122L76.637,53.621c-0.438,0.438-1.039,0.653-1.64,0.651c-0.601,0.002-1.202-0.215-1.64-0.651
c0,0-14.694-14.75-14.706-14.768L35.462,15.723c-1.946-1.946-4.533-3.019-7.286-3.019s-5.34,1.072-7.288,3.019L6.398,30.214
c-4.018,4.018-4.018,10.555,0,14.572l4.62,4.62l9.872,9.872c1.947,1.945,4.534,3.018,7.287,3.018s5.34-1.072,7.286-3.019
l12.453-12.453l-2.121-2.121L33.341,57.156C31.96,58.536,30.126,59.296,28.176,59.296z"/>
</g>
<g>
<path fill="#003B71" d="M75.001,15.704c1.956,0,3.791,0.76,5.171,2.14l37.896,37.898c0.976,0.974,2.343,1.531,3.752,1.531
c1.41,0,2.777-0.558,3.75-1.53l14.491-14.492c1.003-1.002,1.555-2.334,1.555-3.751c0-1.418-0.553-2.751-1.557-3.753L125.57,19.258
c-1.005-1.003-2.336-1.554-3.751-1.554c-1.417,0-2.75,0.552-3.752,1.555l-12.434,12.433l2.121,2.122l12.434-12.434
c0.436-0.436,1.015-0.676,1.631-0.676c0.615,0,1.194,0.24,1.63,0.675l14.49,14.492c0.436,0.435,0.676,1.014,0.676,1.629
s-0.24,1.194-0.676,1.63l-14.49,14.491c-0.871,0.87-2.39,0.869-3.261,0L82.293,15.723c-1.946-1.946-4.533-3.019-7.286-3.019
c-0.003,0-0.006,0-0.009,0c-2.75,0.003-5.333,1.074-7.278,3.019L55.277,28.166l2.121,2.121l12.442-12.443
C71.22,16.467,73.052,15.706,75.001,15.704z"/>
<path fill="#003B71" d="M143.596,30.214l-14.49-14.491c-1.946-1.946-4.533-3.019-7.286-3.019s-5.34,1.072-7.287,3.019
l-12.434,12.434l2.121,2.121l12.434-12.434c1.381-1.38,3.216-2.14,5.166-2.14s3.785,0.76,5.165,2.14l14.49,14.491
c1.381,1.38,2.141,3.214,2.141,5.165c0,1.95-0.761,3.785-2.141,5.166l-14.49,14.49c-1.38,1.38-3.215,2.14-5.165,2.14
s-3.785-0.76-5.167-2.14L78.758,19.258c-1.005-1.003-2.336-1.554-3.751-1.554c-0.003,0-0.016,0-0.019,0
c-1.417,0-2.75,0.552-3.752,1.555L58.803,31.691l2.121,2.122L73.357,21.38c0.436-0.436,1.015-0.676,1.631-0.676
c0.003,0,0.006,0.001,0.01,0.001c0.003,0,0.006-0.001,0.009-0.001c0.615,0,1.194,0.24,1.63,0.675l37.896,37.899
c1.947,1.945,4.534,3.018,7.287,3.018s5.34-1.072,7.286-3.019l14.49-14.49c1.946-1.946,3.02-4.534,3.02-7.287
S145.542,32.159,143.596,30.214z"/>
</g>
<g>
<path fill="#DCAA00" d="M28.176,31.348l6.151,6.152l-6.151,6.152L22.024,37.5L28.176,31.348 M28.176,29.183
c-0.41,0-0.819,0.156-1.131,0.468l-6.718,6.719c-0.625,0.625-0.625,1.637,0,2.262l6.718,6.719
c0.312,0.313,0.722,0.468,1.131,0.468c0.409,0,0.818-0.155,1.131-0.468l6.718-6.719c0.625-0.625,0.625-1.637,0-2.262l-6.718-6.719
C28.994,29.338,28.585,29.183,28.176,29.183L28.176,29.183z"/>
</g>
<g>
<path fill="#DCAA00" d="M121.813,31.348l6.151,6.152l-6.151,6.152l-6.151-6.152L121.813,31.348 M121.813,29.183
c-0.409,0-0.818,0.156-1.131,0.468l-6.718,6.719c-0.625,0.625-0.625,1.637,0,2.262l6.718,6.719
c0.313,0.313,0.722,0.468,1.131,0.468s0.818-0.155,1.131-0.468l6.718-6.719c0.625-0.625,0.625-1.637,0-2.262l-6.718-6.719
C122.631,29.338,122.222,29.183,121.813,29.183L121.813,29.183z"/>
</g>
<path fill="#FFD100" d="M69.421,47.079c-0.091-0.025-0.145-0.068-0.153-0.086c-0.026-0.056-0.044-0.152,0.104-0.324l5.271-6.69
c0.072-0.113,0.091-0.279,0.028-0.394l-2.958-4.264c-0.178-0.248-0.12-0.612,0.124-0.798l8.483-6.511
c0.145-0.114,0.213-0.114,0.238-0.114c0.066,0,0.141,0.046,0.172,0.106c0.049,0.095,0.006,0.186-0.09,0.32l-5.282,6.695
c-0.089,0.121-0.089,0.321-0.005,0.435l2.889,4.157c0.063,0.197,0.169,0.678-0.074,0.865l-8.483,6.504
c-0.081,0.064-0.143,0.11-0.214,0.118C69.454,47.091,69.438,47.084,69.421,47.079z"/>
<g>
<path fill="#407CCA" d="M73.249,39.728l-2.555-3.681c-0.569-0.794-0.396-1.923,0.381-2.516l6.291-4.828l-1.015-1.015
c-0.781-0.78-2.047-0.78-2.828,0l-8.396,8.397c-0.781,0.781-0.781,2.047,0,2.828l4.901,4.901L73.249,39.728z"/>
<path fill="#407CCA" d="M84.748,36.086l-4.829-4.83l-3.171,4.019l2.527,3.636c0.092,0.137,0.159,0.284,0.197,0.432
c0.241,0.898,0.044,1.674-0.546,2.128l-6.365,4.88l0.961,0.962c0.781,0.78,2.047,0.78,2.828,0l8.396-8.397
C85.529,38.133,85.529,36.867,84.748,36.086z"/>
</g>
</g>
</svg>
img/lightning-bolt.svg 0000644 00000002213 15055121352 0010757 0 ustar 00 <?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="12px" height="12px" viewBox="0 0 12 12" enable-background="new 0 0 12 12" xml:space="preserve">
<path fill="#cca300" d="M9.231,0.389c0.007-0.013-0.002-0.032,0.004-0.047c0.016-0.046,0.035-0.093,0.012-0.149
C9.231,0.154,9.2,0.121,9.163,0.097C9.158,0.093,9.15,0.094,9.143,0.091C9.111,0.074,9.079,0.06,9.046,0.06l0,0
c-0.001,0-0.001,0-0.001,0c-0.058,0-0.12,0.021-0.208,0.066c0,0-5.128,4.836-5.129,4.965C3.705,5.22,3.78,5.34,3.913,5.417L6,7.015
L2.864,11.48c-0.027,0.027-0.071,0.071-0.102,0.129c-0.017,0.034-0.007,0.077-0.008,0.116c-0.002,0.027-0.02,0.051-0.007,0.082
c0.03,0.075,0.12,0.133,0.201,0.133c0,0,0,0,0.001,0l0,0c0.057,0,0.119-0.021,0.207-0.066c0,0,5.135-4.836,5.136-4.965
c0.003-0.131-0.071-0.25-0.205-0.327L6,4.986L9.131,0.52C9.156,0.492,9.2,0.446,9.231,0.389z"/>
</svg>
img/info.svg 0000644 00000002505 15055121352 0006775 0 ustar 00 <?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="12px" height="12px" viewBox="0 0 12 12" enable-background="new 0 0 12 12" xml:space="preserve">
<g>
<path fill="#00929E" d="M6,0.5C2.967,0.5,0.5,2.967,0.5,6c0,3.032,2.467,5.5,5.5,5.5c3.032,0,5.5-2.468,5.5-5.5
C11.5,2.967,9.032,0.5,6,0.5z M6,10.5c-2.481,0-4.5-2.019-4.5-4.5S3.519,1.5,6,1.5s4.5,2.019,4.5,4.5S8.481,10.5,6,10.5z"/>
<path fill="#00929E" d="M5.978,3.827c0.158,0,0.295-0.057,0.407-0.168c0.112-0.112,0.168-0.249,0.168-0.407
c0-0.155-0.057-0.292-0.169-0.406c-0.229-0.232-0.593-0.229-0.816,0C5.455,2.959,5.398,3.097,5.398,3.252
c0,0.159,0.057,0.296,0.17,0.408C5.682,3.771,5.819,3.827,5.978,3.827z"/>
<path fill="#00929E" d="M7.201,8.486H6.586V4.622c0-0.059-0.047-0.106-0.106-0.106H4.985c-0.059,0-0.106,0.048-0.106,0.106v0.444
c0,0.059,0.048,0.106,0.106,0.106h0.624v3.314H4.985c-0.059,0-0.106,0.048-0.106,0.107v0.439c0,0.059,0.048,0.105,0.106,0.105
h2.216c0.06,0,0.107-0.047,0.107-0.105V8.594C7.309,8.534,7.261,8.486,7.201,8.486z"/>
</g>
</svg>
Proxy_Context.html 0000644 00000055577 15055121352 0010301 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Proxy Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Proxy Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="LSAPI_Context.html">LSAPI Context</a></li>
<li><span class="current"><a href="Proxy_Context.html">Proxy Context</a></span></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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="LSAPI_Context.html">LiteSpeed SAPI Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="CGI_Context.html">CGI Context</a> »</div></div>
<h1>Proxy Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#proxyContext">Proxy Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#proxyWebServer">Web Server</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="proxyContext"><h3>Proxy Context<span class="ls-permlink"><a href="#proxyContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A Proxy Context enables this virtual host as a transparent reverse proxy server. This proxy server can run in front of any web servers or application servers that support HTTP protocol. The External web server that this virtual host proxies for has to be defined in <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> before you can set up a Proxy Context.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="proxyWebServer"><h3>Web Server<span class="ls-permlink"><a href="#proxyWebServer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the external web server. This external web server must be defined in the <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> section at the server or virtual host level.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
security.html 0000644 00000025155 15055121352 0007310 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Security</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Security." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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><span class="current"><a href="security.html">Security</a></span></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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="admin.html">Administration</a></div><div class="center"><a href="index.html">Home</a></div><div class="next"><a href="config.html">Configuration</a> »</div></div>
<h1>Security</h1>
<p>LiteSpeed Web Server is designed with security as a top consideration.
LSWS supports SSL, has access control at server and virtual host levels,
and context-specific realm protection. Besides these standard features,
LSWS also has the following special security features: </p>
<ol>
<li><h3>Connection level limits:</h3>
<ul>
<li> IP-level throttling limits network bandwidth to and from a single IP
address regardless of the number of connections. </li>
<li> IP-level connection accounting limits the number of concurrent connections
from a single IP address. You can controll this with the connection
soft limit, connection hard limit, grace
period, and banned period settings in the WebAdmin console. </li>
</ul>
</li>
<li><h3>Request checking:</h3>
<p> Every HTTP request is vetted by LiteSpeed Web Server. "/." is not allowed in
a decoded URL, thus denying accessing hidden files and parent directories.</p>
<p>Request size is limited by LiteSpeed Web Server's max request URL length,
max request header length, and max request body length settings. </p>
</li>
<li><h3>Web Application Firewall:</h3>
<p>Request Filtering can be performed on the request header/body to check against possible attack signatures.
This helps defend against XSS attacks and SQL injection attacks, blocking
those requests right from the start. </p>
</li>
<li><h3>Static file checking:</h3>
<p>LiteSpeed Web Server will serve a static file only if the following conditions
are satisfied: </p>
<ul>
<li>The file is readable by everyone.</li>
<li>The file is not executable.</li>
<li>The file is not in the access denied directory list.</li>
<li>The file does not contain symbolic link if symbolic links are not allowed. </li>
<li>By default, LiteSpeed Web Server does not index a directory by listing its
files, it has to be enabled explicitly.</li>
</ul>
</li>
<li><h3>External application firewall:</h3>
<p>LiteSpeed Web Server forwards requests to external applications to process/generate
dynamic content. Those applications can use a lot of system resources. The performance of the
whole system will be severely degraded when system resource consumption reaches a certain point
-- when swapping space has to be used, for example. One way to conduct a DoS attack is to flood
the web server with concurrent requests to a cumbersome external application.</p>
<p>LiteSpeed Web Server can pipeline requests and control the concurrent level of external
application use to prevent overconsumption of system resources. LSWS caches requests and only
forwards completed requests to the external application. This means the external application
will not be held waiting while the server is receiving the request. LSWS also caches the
external application's response so that the external application can be released as soon as
the response is completed and does not have to wait for the client to receive the complete response.
This way the server can utilize fewer external application instances to serve more concurrent
requests and achieve higher performance and scalability. LiteSpeed Web Server also uses its
own virtual memory to cache the request and response body to minimize the usage of system
memory without sacrificing performance. </p></li>
<li><h3>CGI resources consumption limit:</h3>
<p>LiteSpeed Web Server restricts the amount of system resources that can be consumed by
CGI applications. For each request to a CGI script, the web server needs to
start a standalone CGI process to handle it. On a Unix system, the number of concurrent
processes is limited. With the CGI resources consumption limit, you can configure
the maximum number of concurrent CGI instances that the web server can launch.
Excessive concurrent processes will degrade the performance
of the whole system. (CGI processes are a common weapon for DoS attacks.)
A system process limit can be specified per user in order to control the number
of processes that can be spawned by a CGI application. Each process is further confined by CPU and memory limits.</p>
</li>
<li><h3>Enhanced CGI/FastCGI security with suEXEC:</h3>
<p>In order to reduce the security risks of a CGI or Fast CGI script, LiteSpeed Web Server can restrict the system resources the CGI script can access by running it in
"suEXEC" or "chroot jail" mode. "suEXEC" starts the CGI or Fast CGI script with a different user ID from that of the web server. This greatly improves security in
shared hosting environment by preventing one user's CGI script from accessing other users' files.</p>
<p>"chroot jail" starts the CGI script under an assigned alternative
root directory. The script can not access files beyond this new root directory.
With this, you no longer need to worry about confidential system files being
exposed by vulnerable scripts.</p>
</li>
<li><h3>Run LSWS in chroot jail [Enterprise Edition Only]:</h3>
<p> LiteSpeed Web Server can run in a chroot environment (known as a chroot jail).
In the chroot environment, the web server and its child processes cannot access
files outside of the chroot jail. This protects the system from attacks
by malicious code. </p>
</li>
</ol>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
ServGeneral_Help.html 0000644 00000150742 15055121352 0010627 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Server General</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Server General." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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><span class="current"><a href="ServGeneral_Help.html">Server General</a></span></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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><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>
<h1>Server General</h1><section class="ls-spacer-small-bottom">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.</section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Server Process</header><p>
<a href="#serverName">Server Name</a> | <a href="#lswsProcesses">Number of Processes</a> | <a href="#runningAs">Running As</a> | <a href="#serverPriority">Priority</a> | <a href="#cpuAffinity">CPU Affinity</a> | <a href="#servChrootPath">Chroot Path</a> | <a href="#enableChroot">Enable chroot</a> | <a href="#enableLVE">Cloud-Linux</a> | <a href="#inMemBufSize">Max I/O Buffer Size</a> | <a href="#swappingDir">Swapping Directory</a> | <a href="#autoFix503">Auto Fix 503 Error</a> | <a href="#enableh2c">Enable HTTP/2 Over Cleartext TCP</a> | <a href="#gracefulRestartTimeout">Graceful Restart Timeout (secs)</a></p></section>
<section class="toc-row"><header>General Settings</header><p>
<a href="#mime">MIME Settings</a> | <a href="#mimesuffix">Suffixes</a> | <a href="#mimetype">MIME Type</a> | <a href="#disableInitLogRotation">Disable Initial Log Rotation</a> | <a href="#showVersionNumber">Server Signature</a> | <a href="#hideSigInErrorPage">Hide Error Page Signature</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#useIpInProxyHeader">Use Client IP in Header</a> | <a href="#extAppAbort">External Application Abort</a> | <a href="#autoUpdateInterval">Check For Update</a> | <a href="#autoUpdateDownloadPkg">Download Updates</a> | <a href="#adminEmails">Administrator Email</a></p></section>
<section class="toc-row"><header>Index Files</header><p>
<a href="#indexFiles">Index Files</a> | <a href="#autoIndex">Auto Index</a> | <a href="#autoIndexURI">Auto Index URI</a></p></section>
<section class="toc-row"><header><a href="#htaccess">HT Access</a></header><p>
<a href="#allowOverride">Allow Override</a> | <a href="#accessFileName">Access File Name</a></p></section>
<section class="toc-row"><header>Expires Settings</header><p>
<a href="#enableExpires">Enable Expires</a> | <a href="#expiresDefault">Expires Default</a> | <a href="#expiresByType">Expires By Type</a></p></section>
<section class="toc-row"><header><a href="#geolocationDB">MaxMind GeoIP DB</a></header><p>
<a href="#geoipDBFile">DB File Path</a> | <a href="#geoipDBName">DB Name</a> | <a href="#maxMindDBEnv">Environment Variables</a></p></section>
<section class="toc-row"><header>IP2Location DB</header><p>
<a href="#ip2locDBFile">IP2Location DB File Path</a> | <a href="#ip2locDBCache">DB Cache Type</a></p></section>
<section class="toc-row"><header>Using Apache Configuration File</header><p>
<a href="#loadApacheConf">Load Apache Configuration</a> | <a href="#autoReloadApacheConf">Auto Reload On Changes</a> | <a href="#apacheBinPath">Apache Binary Path</a> | <a href="#apacheConfFile">Apache Configuration File</a> | <a href="#apachePortOffset">Apache Port Offset</a> | <a href="#apacheIpOffset">Apache IP Offset</a> | <a href="#apacheHandledContent">Apache Handled Content</a> | <a href="#apacheIgnoredModules">Ignore Apache Modules</a> | <a href="#jitConfig">Just In Time Configuration</a> | <a href="#phpSuExec">PHP suEXEC</a> | <a href="#phpSuExecMaxConn">PHP suEXEC Max Conn</a> | <a href="#apacheEnableFP">Enable FrontPage Extension</a> | <a href="#apacheEnvVars">Apache Environment Variables</a></p></section>
<section class="toc-row"><header>Apache Style Configuration</header><p>
<a href="#apacheConf">Apache Style Configurations</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="serverName"><h3>Server Name<span class="ls-permlink"><a href="#serverName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this server. You can use $HOSTNAME as value.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="lswsProcesses"><h3>Number of Processes<span class="ls-permlink"><a href="#lswsProcesses"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><b>[Only Available For Web Host Elite Licenses]</b> <br /> Specifies the number of lshttpd workers. Enter 0 to have this number be decided automatically.</p> <h4>Syntax</h4><p>Integer value between 0 and 128.</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Set an appropriate number to suit your needs. Adding more processes may not necessarily mean better performance.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="runningAs"><h3>Running As<span class="ls-permlink"><a href="#runningAs"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the user/group that the server process runs as. This value is set during installation. In order to change it, you must download the installation package and perform an upgrade via the command line.</p> <h4>Apply</h4><p>Reinstall required.</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Server should not be run as a privileged user, such as "root". It is critical that the server is configured to run as an un-privileged user/group combination that does not have login/shell access. A user and group of <span class="val">nobody</span> is generally a good choice.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="serverPriority"><h3>Priority<span class="ls-permlink"><a href="#serverPriority"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-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"><div><header id="cpuAffinity"><h3>CPU Affinity<span class="ls-permlink"><a href="#cpuAffinity"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="servChrootPath"><h3>Chroot Path<span class="ls-permlink"><a href="#servChrootPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the directory where the chroot environment is rooted. Only "root" user can run the server in chroot mode. Whether to run in chroot mode is controlled by <span class="tagl"><a href="#enableChroot">Enable chroot</a></span> option. The installer program will set up the initial chroot environment automatically. This entry is read-only, and if you want to change it, please run the installer again from the command line.<br/><br/> In the chroot environment, the server and its child processes cannot access file systems outside of the chroot jail. Chroot is an advanced security feature and additional administration may be required to make it work properly. All required executables, libraries, configuration files, and device files should be recreated within the chroot jail.<br/><br/> As the root directory is changed, you need to pay special attention to path configuration when an absolute path is used. A Unix domain socket or swapping directory is always relative to the new root directory. All other path configurations are always relative to the real root.</p> <h4>Apply</h4><p>Reinstall required.</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Use chroot for better security.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableChroot"><h3>Enable chroot<span class="ls-permlink"><a href="#enableChroot"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies whether to start the server in chroot mode. The new root directory is set by <span class="tagl"><a href="#servChrootPath">Chroot Path</a></span> during installation.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableLVE"><h3>Cloud-Linux<span class="ls-permlink"><a href="#enableLVE"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="inMemBufSize"><h3>Max I/O Buffer Size<span class="ls-permlink"><a href="#inMemBufSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-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"><div><header id="swappingDir"><h3>Swapping Directory<span class="ls-permlink"><a href="#swappingDir"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Place the swapping directory on a separate disk or increase Max I/O Buffer Size to eliminate swapping.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#inMemBufSize">Max I/O Buffer Size</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoFix503"><h3>Auto Fix 503 Error<span class="ls-permlink"><a href="#autoFix503"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="enableh2c"><h3>Enable HTTP/2 Over Cleartext TCP<span class="ls-permlink"><a href="#enableh2c"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="gracefulRestartTimeout"><h3>Graceful Restart Timeout (secs)<span class="ls-permlink"><a href="#gracefulRestartTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>int</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="mime"><h3>MIME Settings<span class="ls-permlink"><a href="#mime"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></span> Click the filename to edit the MIME settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="mimesuffix"><h3>Suffixes<span class="ls-permlink"><a href="#mimesuffix"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="mimetype"><h3>MIME Type<span class="ls-permlink"><a href="#mimetype"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="disableInitLogRotation"><h3>Disable Initial Log Rotation<span class="ls-permlink"><a href="#disableInitLogRotation"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to disable rotation of server error log file at startup. Initial log rotation is enabled by default for standard installations. Servers using cPanel, however, always write to the Apache error log and thus ignore this setting.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="showVersionNumber"><h3>Server Signature<span class="ls-permlink"><a href="#showVersionNumber"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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. <span class="tag">Enterprise Edition Only</span> 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 title="Security" class="ls-icon-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"><div><header id="hideSigInErrorPage"><h3>Hide Error Page Signature<span class="ls-permlink"><a href="#hideSigInErrorPage"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether or not to show the lines <blockquote>Powered By LiteSpeed.<br/> LiteSpeed Technologies is not responsible for administration and contents of this web site!"</blockquote> on your default error pages.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="useIpInProxyHeader"><h3>Use Client IP in Header<span class="ls-permlink"><a href="#useIpInProxyHeader"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="extAppAbort"><h3>External Application Abort<span class="ls-permlink"><a href="#extAppAbort"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>When a client breaks a connection with the server, LiteSpeed Web Server can automatically abort external application processes generating responses for that client. Some users, however, may have (long-running) processes that they wish to continue running whether or not the client is still connected.<br/><br/> There are three options for this:<br/> <ul> <li>No Abort: Never abort external applications because of a broken connection.</li> <li> Enable Abort for Requests from External IPs: Only processes started by requests from external IPs will be automatically aborted because of a broken connection. This is the default setting. It is a good setting if you have some internal long-running processes, like some cron jobs. </li> <li> Enable Abort for All Requests: External application processes will be automatically aborted if the connection is broken, regardless of the source of the request. </li> </ul></p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoUpdateInterval"><h3>Check For Update<span class="ls-permlink"><a href="#autoUpdateInterval"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how often the update agent will check for a new product release. Options are "Daily", "Weekly", "Monthly" and "Disable".</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoUpdateDownloadPkg"><h3>Download Updates<span class="ls-permlink"><a href="#autoUpdateDownloadPkg"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to auto-download a new product release package file when available. If a new package has been successfully downloaded, an online one-click upgrade can be performed via the WebAdmin console under Service Manager - <span class="tagl"><a href="ServerStat_Help.html#vermgr">Version Management</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="adminEmails"><h3>Administrator Email<span class="ls-permlink"><a href="#adminEmails"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></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"><div><header id="indexFiles"><h3>Index Files<span class="ls-permlink"><a href="#indexFiles"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Only set index files that you need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoIndex"><h3>Auto Index<span class="ls-permlink"><a href="#autoIndex"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Security" class="ls-icon-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"><div><header id="autoIndexURI"><h3>Auto Index URI<span class="ls-permlink"><a href="#autoIndexURI"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="htaccess"><h3>HT Access<span class="ls-permlink"><a href="#htaccess"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The following directives are supported in a directory level access control file (.htaccess file).<br/> <ul> <li> Authentication <ul> <li>AuthGroupFile</li> <li>AuthName</li> <li>AuthType</li> <li>AuthUserFile</li> <li>Require</li> <li>Satisfy</li> <li><Limit> (GET, HEAD, POST only)</li> <li><LimitExcept> (GET, HEAD, POST only)</li> </ul> </li> <li> Access Control <ul> <li>Allow</li> <li>Deny</li> <li>Order</li> <li><Limit> (GET, HEAD, POST only)</li> <li><LimitExcept> (GET, HEAD, POST only)</li> </ul> </li> <li> File Info <ul> <li>AddDefaultCharset</li> <li>AddType</li> <li>DefaultType</li> <li>ForceType</li> <li>Redirect</li> <li>RedirectPermanent</li> <li>RedirectTemp</li> <li>RewriteBase</li> <li>RewriteCond</li> <li>RewriteEngine</li> <li>RewriteOptions</li> <li>RewriteRule</li> </ul> </li> <li> Other <ul> <li>DirectoryIndex</li> <li>ExpiresActive</li> <li>ExpiresByType</li> <li>ExpiresDefault</li> <li>Options</li> </ul> </li> </ul></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessFileName"><h3>Access File Name<span class="ls-permlink"><a href="#accessFileName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of access control files. These files will be used only if <span class="tagl"><a href="#allowOverride">Allow Override</a></span> is enabled. Default name is <span class="val">.htaccess</span>. You can configure this at server level and virtual host level. Server level is the default setting, and you can override it at virtual host level.</p> <h4>Syntax</h4><p>Filename starting with "."</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#allowOverride">Allow Override</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableExpires"><h3>Enable Expires<span class="ls-permlink"><a href="#enableExpires"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresDefault"><h3>Expires Default<span class="ls-permlink"><a href="#expiresDefault"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresByType"><h3>Expires By Type<span class="ls-permlink"><a href="#expiresByType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="geolocationDB"><h3>MaxMind GeoIP DB<span class="ls-permlink"><a href="#geolocationDB"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="geoipDBFile"><h3>DB File Path<span class="ls-permlink"><a href="#geoipDBFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="geoipDBName"><h3>DB Name<span class="ls-permlink"><a href="#geoipDBName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="maxMindDBEnv"><h3>Environment Variables<span class="ls-permlink"><a href="#maxMindDBEnv"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="ip2locDBFile"><h3>IP2Location DB File Path<span class="ls-permlink"><a href="#ip2locDBFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="ip2locDBCache"><h3>DB Cache Type<span class="ls-permlink"><a href="#ip2locDBCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="loadApacheConf"><h3>Load Apache Configuration<span class="ls-permlink"><a href="#loadApacheConf"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether LiteSpeed will read and use a Apache configuration file to configure the web server. Native configurations will have higher priority when there is conflict between LiteSpeed internal and Apache-based configurations.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoReloadApacheConf"><h3>Auto Reload On Changes<span class="ls-permlink"><a href="#autoReloadApacheConf"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how to apply Apache configuration changes. When set to "Yes", LSWS will perform a graceful restart whenever the Apache configuration file has been modified. This may cause LSWS to restart multiple times when updating Apache configurations. A better solution (introduced in version 3.3.8) is "Use Apache binary wrapper". This will replace Apache httpd binary with a wrapper script. Whenever Apache is requested to start/stop/restart, the script will tell LSWS to take corresponding action. <span class="tagl"><a href="#apacheBinPath">Apache Binary Path</a></span> must be set to use this setting. Default is "No" for standard installations. For cPanel servers, the default is "Use Apache binary wrapper". ("Override cPanel restart HTTPD script" is an optional workaround that should only be used if the option "Use Apache binary wrapper" is having problems.) For other control panels default is "Yes".</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#apacheBinPath">Apache Binary Path</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheBinPath"><h3>Apache Binary Path<span class="ls-permlink"><a href="#apacheBinPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the Apache binary. Usually, it is located at /usr/local/apache/bin/httpd or /usr/local/apache2/bin/httpd, etc. This option must be set when "Use Apache binary wrapper" is used for <span class="tagl"><a href="#autoReloadApacheConf">Auto Reload On Changes</a></span>.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#autoReloadApacheConf">Auto Reload On Changes</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheConfFile"><h3>Apache Configuration File<span class="ls-permlink"><a href="#apacheConfFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of Apache configuration file. Usually, it is located at /usr/local/apache/conf/httpd.conf or /etc/httpd/conf/httpd.conf.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apachePortOffset"><h3>Apache Port Offset<span class="ls-permlink"><a href="#apachePortOffset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an offset to be added to listening TCP ports specified in the Apache configuration file. In the testing phase, this allows LiteSpeed to run alongside Apache on a different port instead of switching back and forth between LiteSpeed and Apache on a production server.<br/> If set to <span class="val">0</span> or not set, LiteSpeed will use the ports specified in the Apache configuration file. When testing, make this setting a non-zero value. LiteSpeed will then add this offset value to the port specified in the Apache configuration and use this port. After confirming that everything works properly, you can stop Apache, set this option back to <span class="val">0</span>, and restart LiteSpeed.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheIpOffset"><h3>Apache IP Offset<span class="ls-permlink"><a href="#apacheIpOffset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an offset to be added to listening IP address specified in the Apache configuration file. This allows LiteSpeed to run alongside Apache in the testing phase instead of switching back and forth between LiteSpeed and Apache on a production server. The calculated IP address has to be available on this server.</p> <h4>Syntax</h4><p>The offset should be set as an integer (allow negative number), not an IP address. Adding "256" will add 1 to the value of the C class subnet. This option only works with IPv4 address.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheHandledContent"><h3>Apache Handled Content<span class="ls-permlink"><a href="#apacheHandledContent"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies resources to be passed to and processed by Apache on the backend. This feature requires running Apache parallel to LiteSpeed on either another IP or a different port, so either "Apache Port Offset" or "Apache IP Offset" should be set to a non-zero value.</p> <h4>Syntax</h4><p>Resources are specified by a comma delimited list of URI, file suffixes, or regular expressions. A URI starts with "/"; a suffix starts with ".", a regular expression starts with "exp:". For example: "/svn/, .shtml" lets Apache handle requests with a URI starting with "/svn/" or ending with ".shtml". The same effect can be achieved with the regular expression "exp:^/svn/, exp:\.shtml$".</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheIgnoredModules"><h3>Ignore Apache Modules<span class="ls-permlink"><a href="#apacheIgnoredModules"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a list of names of Apache modules that should be ignored by LiteSpeed while parsing the Apache configuration file. LiteSpeed will treat the listed modules as unsupported. This will cause configuration directives related to these modules enclosed in matching <IfModule> or <IfDefined> tags to be ignored.</p> <h4>Syntax</h4><p>comma delimited list of module names</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="jitConfig"><h3>Just In Time Configuration<span class="ls-permlink"><a href="#jitConfig"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>With just in time configuration, the web server only finalizes vhost configurations when that virtual host is accessed for the first time, instead of loading all configurations at start up. This allows the web server to save memory and speed up server start up.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="phpSuExec"><h3>PHP suEXEC<span class="ls-permlink"><a href="#phpSuExec"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to run PHP script in suEXEC mode when "user" and "group" are specified for a virtual host. When set to <span class="val">Yes</span>, PHP scripts will be executed under the user (and group unless <span class="tagl"><a href="ServSecurity_Help.html#forceGID">Force GID</a></span> is set) specified. When set to <span class="val">User's Home Directory Only</span>, scripts outside a user's home directory will run as the global user/group that the web server run as. When using DirectAdmin, <span class="val">User's Home Directory Only</span> is recommended. Default is <span class="val">No</span>.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="ServSecurity_Help.html#forceGID">Force GID</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="phpSuExecMaxConn"><h3>PHP suEXEC Max Conn<span class="ls-permlink"><a href="#phpSuExecMaxConn"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent PHP processes that can be created by LSWS for each user when running PHP scripts in suEXEC mode. Default value is <span class="val">5</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This limit is per user per lshttpd process. Thus, if you have a 2-CPU license, this limit will be doubled. The limit will be 4x for a 4-CPU license, and so on.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheEnableFP"><h3>Enable FrontPage Extension<span class="ls-permlink"><a href="#apacheEnableFP"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to explicitly enable Microsoft Front Page Server Extension or not. Usually, LSWS will enable it when module "frontpage" has been loaded in Apache httpd.conf. However, when mod_frontpage is statically linked into the Apache binary, configuration for the FrontPage module is not in httpd.conf, and you need to enable it explicitly here. Default is "disabled".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheEnvVars"><h3>Apache Environment Variables<span class="ls-permlink"><a href="#apacheEnvVars"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>For shell environment variables used inside the Apache configuration file, LSWS will replace "${ENVVAR}" with the values set here. If the ENVVAR variable is not set here, "${ENVVAR}" occurrences are left unchanged.</p> <h4>Syntax</h4><p>Name and value pairs, one pair per line in the form of ENV=VALUE</p> <h4>See Also</h4><p class="ls-text-small">Apache Env Syntax <a href="http://httpd.apache.org/docs/current/configuring.html#syntax" target="_blank" rel="noopener noreferrer">reference</a></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheConf"><h3>Apache Style Configurations<span class="ls-permlink"><a href="#apacheConf"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies Apache configuration directives (supported by LiteSpeed) that you want to use in LiteSpeed native configuration file. For example, to override the default PHP configurations (php.ini entries) the server will need four directives: "php_value", "php_flag", "php_admin_value" and "php_admin_flag".</p> <h4>Syntax</h4><p>Same as Apache configuration file.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
PageSpeed_Config.html 0000644 00000016331 15055121352 0010557 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - PageSpeed Config</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - PageSpeed Config." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><span class="current"><a href="PageSpeed_Config.html">PageSpeed Config</a></span></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Cache_Help.html">Page Cache Settings</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="ExtApp_Help.html">External Apps</a> »</div></div>
<h1>PageSpeed Config</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>PageSpeed Settings</header><p>
<a href="#pagespeedActivate">Activate PageSpeed</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedActivate"><h3>Activate PageSpeed<span class="ls-permlink"><a href="#pagespeedActivate"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to activate PageSpeed capabilites.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
ExtApp_Help.html 0000644 00000030036 15055121352 0007604 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - External Apps</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - External Apps." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><span class="current"><a href="ExtApp_Help.html">External Apps</a></span></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="PageSpeed_Config.html">PageSpeed Config</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="ScriptHandler_Help.html">Script Handler</a> »</div></div>
<h1>External Apps</h1><section class="ls-spacer-small-bottom">LiteSpeed web server can forward requests to external applications to process and generate dynamic content.
Since 2.0, LiteSpeed Web Server has supported seven types of external applications: CGI, FastCGI, web server, servlet
engine, LiteSpeed SAPI application, load balancer, and piped logger.
<ul>
<li>
CGI stands for Common Gateway Interface. The current standard is CGI/1.1. CGI applications run in standalone
processes. A CGI process is started for each request and will exit after finishing the request.
</li>
<li>
FastCGI is a fast, open, and secure web server interface that solves the performance problems inherent in CGI without
introducing the overhead and complexity of proprietary APIs (Application Programming Interfaces). For more information,
please visit <a href="https://fastcgi-archives.github.io/">https://fastcgi-archives.github.io/</a>.
On LiteSpeed Web Server, FastCGI applications can take two roles: generating dynamic responses (a responder role) or
authorizing requests (an authorizer role). LiteSpeed Web Server further defines two types of FastCGI applications: local
FastCGI and remote FastCGI. Local FastCGI applications are started automatically by the web server on demand.
Remote FastCGI applications are not started by the web server. (They can run on a remote machine or on the same
machine.)
</li>
<li>
A web server is a server application that supports HTTP 1.0/1.1 protocols. LiteSpeed web server can serve as a
transparent reverse proxy to accelerate and protect web servers and application servers. When communicating with
backend web servers, LiteSpeed will always try to utilize persistent connections in order to achieve the highest
performance.
</li>
<li>
A servlet engine is an application, like Apache Tomcat and Jetty, that implements Java servlets and Java Server Pages.
LiteSpeed can communicate with servlet engines through AJPv1.3 (Apache JServ Protocol version 1.3). Servlet engine
cannot be started by the web server and can be setup to run on a remote machine.
</li>
<li>
A LiteSpeed SAPI (LiteSpeed Server Application Programming Interface) application is an application that communicates
with LiteSpeed Web Server through LSAPI, a fast, scalable server interface specifically designed for LiteSpeed Web
Server to achieve maximum efficiency.
LSAPI's mechanism of action are similar to FastCGI, but LSAPI applications can be up to 30% faster than comparable
FastCGI applications. LSAPI is highly recommended over FastCGI for supported applications. (LSAPI currently supports
applications written in PHP, Ruby, and Python.)
For more information about LSAPI, please visit
<a href="https://www.litespeedtech.com/open-source/litespeed-sapi">
https://www.litespeedtech.com/open-source/litespeed-sapi
</a>.
</li>
<li>
A load balancer is a virtual external application, which assigns requests to backend worker applications based on
workload. Worker applications can be CGI, FastCGI, web server, servlet engine, or LSAPI applications. Different types of
applications can be mixed together under one load balancer. Load balancers and piped loggers cannot be used as
worker applications.
</li>
<li>
A piped logger is an application that can process access logs in real-time, writing an access log into database or
performing real-time statistics calculations, for example.
</li>
</ul>
Unlike CGI applications, FastCGI applications, LSAPI applications, and servlet engine do not exit after processing a
request. The application process will stay/persist and serve as many requests as it can. The socket connection can be
reused for multiple requests as well.
External applications can be set up in the {PAGE=ExtApp_Help} section. External applications cannot, however, function
on their own. Additional settings must be configured so that the web server knows which requests to send to which
application. There are two ways to to configure this in LiteSpeed Web Server:
<ol>
<li> Set the external application as a handler for a specific context.</li>
<li> Set the external application as a handler of a script language via file suffix binding.</li>
</ol>
FastCGI applications, LSAPI applications, web servers, servlet engines, and load balancers have to be defined in the
{PAGE=ExtApp_Help} section before you can configure them to handle a context or script suffix. It is not necessary to
define CGI applications in the {PAGE=ExtApp_Help} section.
External applications can be configured at the server level or at the virtual host level. When configured at the server level, the
application can be used by all virtual hosts. When configured at the virtual host level, it can only be used by that virtual host.</section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>New External App</header><p>
<a href="#extAppType">Type</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="extAppType"><h3>Type<span class="ls-permlink"><a href="#extAppType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the type of external application. Application types are differentiated by the service they provide or the protocol they use to communicate with the server. Choose from <ul> <li><span class="val">FastCGI</span>: a FastCGI application with a <span class="val">Responder</span> role.</li> <li><span class="val">FastCGI Authorizer</span>: a FastCGI application with an <span class="val">Authorizer</span> role</li> <li><span class="val">Servlet Engine</span>: a servlet engine with an AJPv13 connector, such as Tomcat.</li> <li><span class="val">Web Server</span>: a web server or application server that supports HTTP protocol.</li> <li><span class="val">LiteSpeed SAPI App</span>: an application that communicates with the web server using LSAPI protocol.</li> <li><span class="val">Load Balancer</span>: a virtual application that can balance load among worker applications.</li> <li><span class="val">Piped Logger</span>: an application that can process access log entries received on its STDIN stream.</li> </ul></p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Most applications will use either LSAPI or FastCGI protocol. LSAPI supports PHP, Ruby, and Python. Perl can be used with FastCGI. (PHP, Ruby, and Python can also be set up to run using FastCGI, but they run faster using LSAPI.) Java uses servlet engines.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
AdminSecurity_Help.html 0000644 00000023637 15055121352 0011174 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Admin Console Security</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Admin Console Security." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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><span class="current"><a href="AdminSecurity_Help.html">Admin Console Security</a></span></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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="AdminGeneral_Help.html">Admin Console General</a></div><div class="center"><a href="webconsole.html">Web Console</a></div><div class="next"><a href="AdminListeners_General_Help.html">Admin Listeners General</a> »</div></div>
<h1>Admin Console Security</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#accessControl">Access Control</a></header><p>
<a href="#accessControl_allow">Allowed List</a> | <a href="#accessControl_deny">Denied List</a></p></section>
<section class="toc-row"><header><a href="#adminUser">WebAdmin User</a></header><p>
</p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="accessControl"><h3>Access Control<span class="ls-permlink"><a href="#accessControl"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what sub networks and/or IP addresses can access the server. At the server level, this setting will affect all virtual hosts. You can also set up access control unique to each virtual host at the virtual host level. Virtual host level settings will NOT override server level settings.<br/><br/> Blocking/Allowing an IP is determined by the combination of the allowed list and the denied list. If you want to block only certain IPs or sub-networks, put <span class="val">*</span> or <span class="val">ALL</span> in the <span class="tagl"><a href="#accessControl_allow">Allowed List</a></span> and list the blocked IPs or sub-networks in the <span class="tagl"><a href="#accessControl_deny">Denied List</a></span>. If you want to allow only certain IPs or sub-networks, put <span class="val">*</span> or <span class="val">ALL</span> in the <span class="tagl"><a href="#accessControl_deny">Denied List</a></span> and list the allowed IPs or sub-networks in the <span class="tagl"><a href="#accessControl_allow">Allowed List</a></span>. The setting of the smallest scope that fits for an IP will be used to determine access.<br/><br/> <b>Server Level:</b> Trusted IPs or sub-networks must be specified in the <span class="tagl"><a href="#accessControl_allow">Allowed List</a></span> by adding a trailing "T". Trusted IPs or sub-networks are not affected by connection/throttling limits. Only server level access control can set up trusted IPs/sub-networks.</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Use this at the server level for general restrictions that apply to all virtual hosts.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessControl_allow"><h3>Allowed List<span class="ls-permlink"><a href="#accessControl_allow"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the list of IPs or sub-networks allowed. <span class="val">*</span> or <span class="val">ALL</span> are accepted.</p> <h4>Syntax</h4><p>Comma delimited list of IP addresses or sub-networks. A trailing "T" can be used to indicate a trusted IP or sub-network, such as <span class="val">192.168.1.*T</span>.</p> <h4>Example</h4><div class="ls-example"><b>Sub-networks:</b> 192.168.1.0/255.255.255.0, 192.168.1.0/24, 192.168.1, or 192.168.1.*<br/> <b>IPv6 addresses:</b> ::1 or [::1]<br/> <b>IPv6 subnets:</b> 3ffe:302:11:2:20f:1fff:fe29:717c/64 or [3ffe:302:11:2:20f:1fff:fe29:717c]/64</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks set at the server level access control will be excluded from connection/throttling limits.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessControl_deny"><h3>Denied List<span class="ls-permlink"><a href="#accessControl_deny"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the list of IPs or sub-networks disallowed.</p> <h4>Syntax</h4><p>Comma delimited list of IP addresses or sub-networks. <span class="val">*</span> or <span class="val">ALL</span> are accepted.</p> <h4>Example</h4><div class="ls-example"><b>Sub-networks:</b> 192.168.1.0/255.255.255.0, 192.168.1.0/24, 192.168.1, or 192.168.1.*<br/> <b>IPv6 addresses:</b> ::1 or [::1]<br/> <b>IPv6 subnets:</b> 3ffe:302:11:2:20f:1fff:fe29:717c/64 or [3ffe:302:11:2:20f:1fff:fe29:717c]/64</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="adminUser"><h3>WebAdmin User<span class="ls-permlink"><a href="#adminUser"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Change the username and password for the WebAdmin Console. The old password must be entered and verified in order to save changes.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
AdminGeneral_Help.html 0000644 00000044740 15055121352 0010740 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Admin Console General</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Admin Console General." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</a></li>
</ul>
</li>
<li>
<a href="webconsole.html">Web Console</a>
<ul class="level2">
<li><span class="current"><a href="AdminGeneral_Help.html">Admin Console General</a></span></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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev"> </div><div class="center"><a href="webconsole.html">Web Console</a></div><div class="next"><a href="AdminSecurity_Help.html">Admin Console Security</a> »</div></div>
<h1>Admin Console General</h1><section class="ls-spacer-small-bottom">Admin Server is a special virtual host dedicated to the WebAdmin console.
It is very important to make sure Admin Server is securely protected either by only allowing
access from the administrator's machines or by using an encrypted SSL connection.</section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>General</header><p>
<a href="#enableCoreDump">Enable Core Dump</a> | <a href="#consoleSessionTimeout">Session Timeout (secs)</a></p></section>
<section class="toc-row"><header>Virtual Host Log</header><p>
<a href="#logUseServer">Use Server's Log</a> | <a href="#vhlog_fileName">File Name</a> | <a href="#vhlog_logLevel">Log Level</a> | <a href="#log_rollingSize">Rolling Size (bytes)</a> | <a href="#log_keepDays">Keep Days</a> | <a href="#log_compressArchive">Compress Archive</a></p></section>
<section class="toc-row"><header>Access Log</header><p>
<a href="#aclogUseServer">Log Control</a> | <a href="#vhaccessLog_fileName">File Name</a> | <a href="#accessLog_pipedLogger">Piped Logger</a> | <a href="#accessLog_logFormat">Log Format</a> | <a href="#accessLog_logHeader">Log Headers</a> | <a href="#log_rollingSize">Rolling Size (bytes)</a> | <a href="#log_keepDays">Keep Days</a> | <a href="#log_compressArchive">Compress Archive</a> | <a href="#accessLog_bytesLog">Bytes Log</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="enableCoreDump"><h3>Enable Core Dump<span class="ls-permlink"><a href="#enableCoreDump"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable core dump when the server is started by "root" user. For most modern Unix systems, processes that change user ID or group ID are not allowed to dump a core file for security reasons. However, it is much easier to identify root cause of a problem with a core dump. This option only works on Linux kernel 2.4 and up. Solaris users should use the <span class="cmd">coreadm</span> command to control this feature.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Only enable this when you see <span class="val">no core file created</span> in the server log file. Disable it immediately after producing the core file. Please submit a bug report when a core dump has been created.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="consoleSessionTimeout"><h3>Session Timeout (secs)<span class="ls-permlink"><a href="#consoleSessionTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Customize the session timeout length of the WebAdmin Console. The default is 60 seconds.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Set a proper value for production use, usually less than 300 seconds.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="logUseServer"><h3>Use Server's Log<span class="ls-permlink"><a href="#logUseServer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="vhlog_fileName"><h3>File Name<span class="ls-permlink"><a href="#vhlog_fileName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Place the log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vhlog_logLevel"><h3>Log Level<span class="ls-permlink"><a href="#vhlog_logLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-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"><div><header id="log_rollingSize"><h3>Rolling Size (bytes)<span class="ls-permlink"><a href="#log_rollingSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></span> Append "K", "M", "G" to the number for kilo-, mega- and giga- bytes.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="log_keepDays"><h3>Keep Days<span class="ls-permlink"><a href="#log_keepDays"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="log_compressArchive"><h3>Compress Archive<span class="ls-permlink"><a href="#log_compressArchive"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></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"><div><header id="aclogUseServer"><h3>Log Control<span class="ls-permlink"><a href="#aclogUseServer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="vhaccessLog_fileName"><h3>File Name<span class="ls-permlink"><a href="#vhaccessLog_fileName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Put access log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessLog_pipedLogger"><h3>Piped Logger<span class="ls-permlink"><a href="#accessLog_pipedLogger"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="accessLog_logFormat"><h3>Log Format<span class="ls-permlink"><a href="#accessLog_logFormat"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="accessLog_logHeader"><h3>Log Headers<span class="ls-permlink"><a href="#accessLog_logHeader"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-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"><div><header id="accessLog_bytesLog"><h3>Bytes Log<span class="ls-permlink"><a href="#accessLog_bytesLog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Put the log file on a separate disk.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
ServSecurity_Help.html 0000644 00000220552 15055121352 0011056 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Server Security</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Server Security." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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><span class="current"><a href="ServSecurity_Help.html">Server Security</a></span></li>
<li><a href="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="ServTuning_Help.html">Server Tuning</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="Cache_Help.html">Page Cache Settings</a> »</div></div>
<h1>Server Security</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Anti-DDoS Protection</header><p>
<a href="#enableAntiddos">Enable Anti-DDoS Protection</a> | <a href="#firewallEnable">Enable Firewall Modifications</a></p></section>
<section class="toc-row"><header>WordPress Brute Force Attack Protection</header><p>
<a href="#wpProtectAction">Protection Mode</a> | <a href="#wpProtectLimit">Allowed Login Attempts</a></p></section>
<section class="toc-row"><header>Web Application Firewall (WAF)</header><p>
<a href="#enableCensorship">Enable WAF</a> | <a href="#censorLogLevel">Log Level</a> | <a href="#defaultAction">Default Action</a> | <a href="#scanPOST">Scan Request Body</a> | <a href="#uploadTmpDir">Temporary File Path</a> | <a href="#uploadTmpFilePermission">Temporary File Permissions</a> | <a href="#disableSecHtaccess">Disable .htaccess Override</a> | <a href="#secAuditLogEngine">Enable Security Audit Log</a> | <a href="#secAuditLog">Security Audit Log</a> | <a href="#useRe2">Use RE2 regex engine</a></p></section>
<section class="toc-row"><header><a href="#reqCensorshipRule">Web Application Firewall (WAF) Rule Set</a></header><p>
<a href="#censorRuleSetName">Name</a> | <a href="#ruleSetAction">Rule Set Action</a> | <a href="#censorRuleSetEnabled">Enabled</a> | <a href="#censorRuleSet">Rules Definition</a></p></section>
<section class="toc-row"><header><a href="#perClientConnLimit">Per Client Throttling</a></header><p>
<a href="#staticReqPerSec">Static Requests/Second</a> | <a href="#dynReqPerSec">Dynamic Requests/Second</a> | <a href="#outBandwidth">Outbound Bandwidth (bytes/sec)</a> | <a href="#inBandwidth">Inbound Bandwidth (bytes/sec)</a> | <a href="#softLimit">Connection Soft Limit</a> | <a href="#hardLimit">Connection Hard Limit</a> | <a href="#blockBadReq">Block Bad Request</a> | <a href="#gracePeriod">Grace Period (sec)</a> | <a href="#banPeriod">Banned Period (sec)</a></p></section>
<section class="toc-row"><header>File Access</header><p>
<a href="#followSymbolLink">Follow Symbolic Link</a> | <a href="#checkSymbolLink">Check Symbolic Link</a> | <a href="#forceStrictOwnership">Force Strict Ownership Checking</a> | <a href="#requiredPermissionMask">Required Permission Mask</a> | <a href="#restrictedPermissionMask">Restricted Permission Mask</a> | <a href="#restrictedScriptPermissionMask">Script Restricted Permission Mask</a> | <a href="#restrictedDirPermissionMask">Script Directory Restricted Permission Mask</a></p></section>
<section class="toc-row"><header><a href="#cgiResource">CGI Settings</a></header><p>
<a href="#cgidSock">CGI Daemon Socket</a> | <a href="#maxCGIInstances">Max CGI Instances</a> | <a href="#minUID">Minimum UID</a> | <a href="#minGID">Minimum GID</a> | <a href="#forceGID">Force GID</a> | <a href="#umask">umask</a> | <a href="#CGIPriority">CGI Priority</a> | <a href="#CPUSoftLimit">CPU Soft Limit (sec)</a> | <a href="#CPUHardLimit">CPU Hard Limit</a> | <a href="#memSoftLimit">Memory Soft Limit (bytes)</a> | <a href="#memHardLimit">Memory Hard Limit (bytes)</a> | <a href="#procSoftLimit">Process Soft Limit</a> | <a href="#procHardLimit">Process Hard Limit</a> | <a href="#cgroups">cgroups</a></p></section>
<section class="toc-row"><header><a href="#lsrecaptcha">reCAPTCHA Protection</a></header><p>
<a href="#enableRecaptcha">Enable reCAPTCHA</a> | <a href="#recaptchaSiteKey">Site Key</a> | <a href="#recaptchaSecretKey">Secret Key</a> | <a href="#recaptchaType">reCAPTCHA Type</a> | <a href="#recaptchaSensitivity">Trigger Sensitivity</a> | <a href="#recaptchaMaxTries">Max Tries</a> | <a href="#verifyExpires">Verification Expires (secs)</a> | <a href="#recaptchaAllowedRobotHits">Allowed Robot Hits</a> | <a href="#recaptchaBotWhiteList">Bot White List</a></p></section>
<section class="toc-row"><header>Containers</header><p>
<a href="#bubbleWrap">Bubblewrap Container</a> | <a href="#bubbleWrapCmd">Bubblewrap Command</a> | <a href="#namespace">Namespace Container</a> | <a href="#namespaceConf">Namespace Template File</a></p></section>
<section class="toc-row"><header>Access Denied Directories</header><p>
<a href="#accessDenyDir">Access Denied Directories</a></p></section>
<section class="toc-row"><header><a href="#accessControl">Access Control</a></header><p>
<a href="#accessControl_allow">Allowed List</a> | <a href="#accessControl_deny">Denied List</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="enableAntiddos"><h3>Enable Anti-DDoS Protection<span class="ls-permlink"><a href="#enableAntiddos"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>This will enable bot detection and address them by denying or redirecting the client to reCAPTCHA. If firewall is enabled, the client IP will be denied at the firewall level.<br/><br/> Default value is <span class="val">Yes</span>.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="firewallEnable"><h3>Enable Firewall Modifications<span class="ls-permlink"><a href="#firewallEnable"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enable firewall modifications via iptables. iptables must be enabled on this system for this setting to take effect.<br/><br/> If ipset is also installed and enabled on this system, it will be used to more efficiently manage firewall rulesets for iptables.<br/><br/> Default value is <span class="val">Yes</span>.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> ipset should be installed and enabled on the system to more efficiently manage firewall rulesets for iptables.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="wpProtectAction"><h3>Protection Mode<span class="ls-permlink"><a href="#wpProtectAction"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the action to be taken when the specified Allowed Login Attempts limit is reached within 5 minutes.<br/><br/> <span class="val">Throttle</span> gradually slows down the speed of the server response, <span class="val">Drop</span> severs the connection without any reply, <span class="val">Deny</span> returns a 403 response, and <span class="val">CAPTCHA or Drop</span> redirects to a CAPTCHA if reCAPTCHA Protection is enabled and drops otherwise.<br/><br/> <span class="val">WP Login CAPTCHA Full Protection</span> can also be selected. This setting will redirect to a CAPTCHA if ReCAPTCHA Protection is enabled regardless of Allowed Login Attempts limit and falls back to use <span class="val">Throttle</span> otherwise.<br/><br/> Default values:<br/> <b>Server level:</b> <span class="val">Throttle</span><br/> <b>VH level:</b> Inherit Server level setting. If Server level is set to <span class="val">Disable</span>, <span class="val">Throttle</span> will be used.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.<br/> <span title="Information" class="ls-icon-info"></span> This feature is enabled by default (Throttle) and does not need any further configuration in the WebAdmin GUI or in Apache configurations.<br/> <span title="Information" class="ls-icon-info"></span> This setting will override Apache conf <span class="val">WordPressProtect</span> setting for LSWS only. Apache will be unaffected.<br/><br/> <span title="Information" class="ls-icon-info"></span> This can be set at the Server level and overwritten at the Virtual Host level. If not overridden at the Virtual Host level, this setting can also be overridden in a user's docroot .htaccess file using Apache configuration directive <span class="val">WordPressProtect</span> with value <span class="val">0</span> (disabled), <span class="val">1</span> (use server level setting), <span class="val">throttle</span>, <span class="val">deny</span>, or <span class="val">drop</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="wpProtectLimit"><h3>Allowed Login Attempts<span class="ls-permlink"><a href="#wpProtectLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of wp-login.php and xmlrpc.php POST attempts allowed by an IP within 5 minutes before the action specified in <span class="tagl"><a href="#wpProtectAction">Protection Mode</a></span> is taken.<br/><br/> This limit is handled using a quota system where remaining attempts = limit. Each POST attempt will decrease the number of remaining attempts by 1, with the number of remaining attempts increasing back to the set limit over time. An IP will be throttled once the number of remaining attempts for that IP falls to 1/2 the set limit, throttling more as the remaining attempts drops further below the 1/2 mark. When remaining attempts reaches 0, the specified action is taken toward the IP.<br/><br/> In addition to this, if <span class="tagl"><a href="#enableRecaptcha">Enable reCAPTCHA</a></span> is also enabled, an additional per worker protection will be added. If wp-login.php and xmlrpc.php are visited by the same worker at a rate of 4x the set limit in a 30 second time frame, those URLs will be put into reCAPTCHA mode until the number of visits to these files decreases.<br/><br/> Resetting the server will clear blocked IPs.<br/><br/> Default values:<br/> <b>Server-level:</b> <span class="val">10</span><br/> <b>VH-Level:</b> Inherit Server level setting</p> <h4>Syntax</h4><p>Valid Range: 3 - 1000.</p> <h4>Example</h4><div class="ls-example">With an Attempt limit of 10, and a Mode of drop:<br/><br/> After the first POST attempt, the quota is decreased to 9.<br/><br/> Quota decreases by 1 for each POST attempt.<br/><br/> After Quota reaches half of the limit (5), the IP will be throttled.<br/><br/> Throttling will get worse with each POST attempt.<br/><br/> Once the quota reaches 0, the connection will be dropped.</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.<br/><br/> <span title="Information" class="ls-icon-info"></span> This setting will override Apache conf <span class="val">WordPressProtect</span> setting for LSWS only. Apache will be unaffected.<br/><br/> <span title="Information" class="ls-icon-info"></span> This can be set at the Server level and overwritten at the Virtual Host level. If not overridden at the Virtual Host level, this setting can also be overridden in a user's docroot .htaccess file using Apache configuration directive <span class="val">WordPressProtect</span> with integer value between 3 and 1000.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableCensorship"><h3>Enable WAF<span class="ls-permlink"><a href="#enableCensorship"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable request content deep inspection. This feature is equivalent to Apache's mod_security, which can be used to detect and block requests with ill intention by matching them to known signatures.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="censorLogLevel"><h3>Log Level<span class="ls-permlink"><a href="#censorLogLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the level of detail of the Web Application Firewall engine's debug output. This value ranges from <span class="val">0</span> - <span class="val">9</span>. <span class="val">0</span> disables logging. <span class="val">9</span> produces the most detailed log. The the server and virtual host's error log <span class="tagl"><a href="ServGeneral_Help.html#log_logLevel">Log Level</a></span> must be set to at least <span class="val">INFO</span> for this option to take effect. This is useful when testing request filtering rules.</p> <h4>Syntax</h4><p>Integer number</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#log_logLevel">Log Level</a></span>, Virtual Host <span class="tagl"><a href="VHGeneral_Help.html#vhlog_logLevel">Log Level</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultAction"><h3>Default Action<span class="ls-permlink"><a href="#defaultAction"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the default actions that should be taken when a censoring rule is met. Default value is <span class="val">deny,log,status:403</span>, which means to deny access with status code 403 and log the incident in the error log.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#ruleSetAction">Rule Set Action</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="scanPOST"><h3>Scan Request Body<span class="ls-permlink"><a href="#scanPOST"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to check the body of an HTTP POST request. Default is "No".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="uploadTmpDir"><h3>Temporary File Path<span class="ls-permlink"><a href="#uploadTmpDir"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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</span>.</p> <h4>Syntax</h4><p>Absolute path or path starting with $SERVER_ROOT (for Server and VHost levels).</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="uploadTmpFilePermission"><h3>Temporary File Permissions<span class="ls-permlink"><a href="#uploadTmpFilePermission"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Global setting determining file permissions used for files stored in the <b>Temporary File Path</b> directory.</p> <h4>Syntax</h4><p>3 digits octet number. Default value is 666.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="disableSecHtaccess"><h3>Disable .htaccess Override<span class="ls-permlink"><a href="#disableSecHtaccess"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Disable turning off mod_security engine in .htaccess. This is a global setting only available at the server level. Default is "No".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="secAuditLogEngine"><h3>Enable Security Audit Log<span class="ls-permlink"><a href="#secAuditLogEngine"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable audit logging and in what format (Native, JSON, or Pretty JSON). This feature is equivalent to Apache's mod_security audit engine.<br/><br/> If this setting is enabled and the <span class="tagl"><a href="#secAuditLog">Security Audit Log</a></span> setting is set, detailed request information will be saved.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#secAuditLog">Security Audit Log</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="secAuditLog"><h3>Security Audit Log<span class="ls-permlink"><a href="#secAuditLog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the path of the security audit log, which gives more detailed information. This extra information can be useful if, for example, you wish to track the actions of a particular user. Use <span class="tagl"><a href="#secAuditLogEngine">Enable Security Audit Log</a></span> to turn on the logging.</p> <h4>Syntax</h4><p>Filename which can be an absolute path or a relative path to $SERVER_ROOT.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#secAuditLogEngine">Enable Security Audit Log</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="useRe2"><h3>Use RE2 regex engine<span class="ls-permlink"><a href="#useRe2"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Use RE2 when evaluating regular expressions instead of PCRE.<br/><br/> Default value: <span class="val">No</span></p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> While PCRE provides more features than RE2, RE2 allows for a defined maximum memory usage and has a more predictable runtime than PCRE making it more suited for use in server applications.<br/> <span title="Performance" class="ls-icon-performance"></span> Unlike PCRE, RE2 uses a fixed stack and guarantees that run-time increases linearly (not exponentially) with the size of the input.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="reqCensorshipRule"><h3>Web Application Firewall (WAF) Rule Set<span class="ls-permlink"><a href="#reqCensorshipRule"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Rules configured here only work for virtual hosts configured with a native LSWS configuration, not for virtual hosts using Apache httpd.conf.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="censorRuleSetName"><h3>Name<span class="ls-permlink"><a href="#censorRuleSetName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Give a group of censorship rules a name. For display only.</p> <h4>Syntax</h4><p>String</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ruleSetAction"><h3>Rule Set Action<span class="ls-permlink"><a href="#ruleSetAction"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the actions that should be taken when a censoring rule in current ruleset is met. If not set, <span class="tagl"><a href="#defaultAction">Default Action</a></span> will be used.</p> <h4>Syntax</h4><p>String. This action string uses the same syntax as Apache's <a href=" https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecDefaultAction " target="_blank" rel="noopener noreferrer"> mod_security SecDefaultAction directive </a> .</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="censorRuleSetEnabled"><h3>Enabled<span class="ls-permlink"><a href="#censorRuleSetEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable this rule set. With this option, a rule set can be quickly turned on and off without adding or removing the rule set. Default is "Yes".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="censorRuleSet"><h3>Rules Definition<span class="ls-permlink"><a href="#censorRuleSet"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a list of censorship rules.<br/><br/> If you are using an Apache config file, you have to set up rules in httpd.conf. Rules defined here will have no effect.</p> <h4>Syntax</h4><p>String. Syntax of censoring rules follows that of Apache's mod_security directives. "SecFilter", "SecFilterSelective", and "SecRule" can be used here. You can copy and paste security rules from an Apache configuration file.<br/><br/> For more details about rule syntax, please refer to the <a href="http://www.modsecurity.org/documentation/index.html" target="_blank" rel="noopener noreferrer">Mod Security documentation</a>.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Rules configured here only work for vhosts configured in native LSWS configuration, not for vhosts from Apache httpd.conf.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="perClientConnLimit"><h3>Per Client Throttling<span class="ls-permlink"><a href="#perClientConnLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>These are connection control settings are based on client IP. These settings help to mitigate DoS (Denial of Service) and DDoS (Distributed Denial of Service) attacks.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="staticReqPerSec"><h3>Static Requests/Second<span class="ls-permlink"><a href="#staticReqPerSec"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of requests to static content coming from a single IP address that can be processed in a single second regardless of the number of connections established.<br/><br/> When this limit is reached, all future requests are tar-pitted until the next second. Request limits for dynamically generated content are independent of this limit. Per-client request limits can be set at server- or virtual host-level. Virtual host-level settings override server-level settings.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#dynReqPerSec">Dynamic Requests/Second</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="dynReqPerSec"><h3>Dynamic Requests/Second<span class="ls-permlink"><a href="#dynReqPerSec"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of requests to dynamically generated content coming from a single IP address that can be processed in each second regardless of the number of connections established. When this limit is reached, all future requests to dynamic content are tar-pitted until the next second.<br/><br/> The request limit for static content is independent of this limit. This per client request limit can be set at server or virtual host level. Virtual host-level settings override server-level settings.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not restrained by this limit.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#staticReqPerSec">Static Requests/Second</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="outBandwidth"><h3>Outbound Bandwidth (bytes/sec)<span class="ls-permlink"><a href="#outBandwidth"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The maximum allowed outgoing throughput to a single IP address, regardless of the number of connections established. The real bandwidth may end up being slightly higher than this setting for efficiency reasons. Bandwidth is allocated in 4KB units. Set to <span class="val">0</span> to disable throttling. Per-client bandwidth limits (bytes/sec) can be set at the server or virtual host level where virtual host level settings override server level settings.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Set the bandwidth in 8KB units for better performance.<br/><br/> <span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#inBandwidth">Inbound Bandwidth (bytes/sec)</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="inBandwidth"><h3>Inbound Bandwidth (bytes/sec)<span class="ls-permlink"><a href="#inBandwidth"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The maximum allowed incoming throughput from a single IP address, regardless of the number of connections established. The real bandwidth may end up being slightly higher than this setting for efficiency reasons. Bandwidth is allocated in 1KB units. Set to <span class="val">0</span> to disable throttling. Per-client bandwidth limits (bytes/sec) can be set at the server or virtual host level where virtual host level settings override server level settings.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#outBandwidth">Outbound Bandwidth (bytes/sec)</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="softLimit"><h3>Connection Soft Limit<span class="ls-permlink"><a href="#softLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the soft limit of concurrent connections allowed from one IP. This soft limit can be exceeded temporarily during <span class="tagl"><a href="#gracePeriod">Grace Period (sec)</a></span> as long as the number is below the <span class="tagl"><a href="#hardLimit">Connection Hard Limit</a></span>, but Keep-Alive connections will be closed as soon as possible until the number of connections is lower than the limit. If number of connections is still over the limit after the <span class="tagl"><a href="#gracePeriod">Grace Period (sec)</a></span>, that IP will be blocked for the <span class="tagl"><a href="#banPeriod">Banned Period (sec)</a></span>.<br/><br/> For example, if a page contains many small graphs, the browser may try to set up many connections at same time, especially for HTTP/1.0 clients. You would want to allow those connections for a short period.<br/><br/> HTTP/1.1 clients may also set up multiple connections to speed up downloading and SSL requires separate connections from non-SSL connections. Make sure the limit is set properly, as not to adversely affect normal service. The recommended limit is between <span class="val">5</span> and <span class="val">10</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> A lower number will enable serving more distinct clients.<br/> <span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.<br/> <span title="Performance" class="ls-icon-performance"></span> Set to a high value when you are performing benchmark tests with a large number of concurrent client machines.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="hardLimit"><h3>Connection Hard Limit<span class="ls-permlink"><a href="#hardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of allowed concurrent connections from a single IP address. This limit is always enforced and a client will never be able to exceed this limit. HTTP/1.0 clients usually try to set up as many connections as they need to download embedded content at the same time. This limit should be set high enough so that HTTP/1.0 clients can still access the site. Use <span class="tagl"><a href="#softLimit">Connection Soft Limit</a></span> to set the desired connection limit.<br/><br/> The recommended limit is between <span class="val">20</span> and <span class="val">50</span> depending on the content of your web page and your traffic load.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> A lower number will enable serving more distinct clients.<br/> <span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.<br/> <span title="Performance" class="ls-icon-performance"></span> Set to a high value when you are performing benchmark tests with a large number of concurrent client machines.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="blockBadReq"><h3>Block Bad Request<span class="ls-permlink"><a href="#blockBadReq"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Block IPs that keep sending badly-formatted HTTP requests for the <span class="tagl"><a href="#banPeriod">Banned Period (sec)</a></span>. Default is <span class="val">Yes</span>. This helps to block botnet attacks that repeatedly sending junk requests.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="gracePeriod"><h3>Grace Period (sec)<span class="ls-permlink"><a href="#gracePeriod"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long new connections can be accepted after the number of connections established from one IP is over the <span class="tagl"><a href="#softLimit">Connection Soft Limit</a></span>. Within this period, new connections will be accepted if the total connections is still below the <span class="tagl"><a href="#hardLimit">Connection Hard Limit</a></span>. After this period has elapsed, if the number of connections still higher than the <span class="tagl"><a href="#softLimit">Connection Soft Limit</a></span>, then the offending IP will be blocked for the <span class="tagl"><a href="#banPeriod">Banned Period (sec)</a></span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span><span title="Security" class="ls-icon-security"></span> Set to a proper number big enough for downloading a complete page but low enough to prevent deliberate attacks.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="banPeriod"><h3>Banned Period (sec)<span class="ls-permlink"><a href="#banPeriod"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long new connections will be rejected from an IP if, after the <span class="tagl"><a href="#gracePeriod">Grace Period (sec)</a></span> has elapsed, the number of connections is still more than the <span class="tagl"><a href="#softLimit">Connection Soft Limit</a></span>. If IPs are getting banned repeatedly, we suggest that you increase your banned period to stiffen the penalty for abuse.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="followSymbolLink"><h3>Follow Symbolic Link<span class="ls-permlink"><a href="#followSymbolLink"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the server-level default setting of following symbolic links when serving static files.<br/><br/> Choices are <span class="val">Yes</span>, <span class="val">If Owner Match</span> and <span class="val">No</span>.<br/><br/> <span class="val">Yes</span> sets the server to always follow symbolic links. <span class="val">If Owner Match</span> sets the server to follow a symbolic link only if the owner of the link and of the target are same. <span class="val">No</span> means the server will never follow a symbolic link. This setting can be overridden in the virtual host configurations but cannot be overridden from an .htaccess file.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span><span title="Security" class="ls-icon-security"></span> For best security select <span class="val">No</span> or <span class="val">If Owner Match</span>. For best performance, select <span class="val">Yes</span>.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#checkSymbolLink">Check Symbolic Link</a></span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="checkSymbolLink"><h3>Check Symbolic Link<span class="ls-permlink"><a href="#checkSymbolLink"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to check symbolic links against <span class="tagl"><a href="#accessDenyDir">Access Denied Directories</a></span> when <span class="tagl"><a href="#followSymbolLink">Follow Symbolic Link</a></span> is turned on. If enabled, the canonical real path of the resource referred by a URL will be checked against the configurable access denied directories. Access will be denied if it falls inside an access denied directory.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span><span title="Security" class="ls-icon-security"></span> For best security, enable this option. For best performance, disable it.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#followSymbolLink">Follow Symbolic Link</a></span>, <span class="tagl"><a href="#accessDenyDir">Access Denied Directories</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="forceStrictOwnership"><h3>Force Strict Ownership Checking<span class="ls-permlink"><a href="#forceStrictOwnership"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enforce strict file ownership checking. If it is enabled, the web server will check if the owner of the file being served is the same as the owner of the virtual host. If it is different, a 403 Access Denied Error will be returned. This is turned off by default.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> For shared hosting, enable this check for better security.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="requiredPermissionMask"><h3>Required Permission Mask<span class="ls-permlink"><a href="#requiredPermissionMask"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the required permission mask for static files that the server will serve. For example, if only files that are readable by everyone can be served, set the value to <span class="val">0004</span>. See <span class="cmd">man 2 stat</span> for all values.</p> <h4>Syntax</h4><p>octal numbers</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#restrictedPermissionMask">Restricted Permission Mask</a></span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="restrictedPermissionMask"><h3>Restricted Permission Mask<span class="ls-permlink"><a href="#restrictedPermissionMask"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the restricted permission mask for static files that the server will not serve. For example, to prohibit serving files that are executable, set the mask to <span class="val">0111</span>.<br/><br/> See <span class="cmd">man 2 stat</span> for all values.</p> <h4>Syntax</h4><p>octal numbers</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#requiredPermissionMask">Required Permission Mask</a></span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="restrictedScriptPermissionMask"><h3>Script Restricted Permission Mask<span class="ls-permlink"><a href="#restrictedScriptPermissionMask"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the restricted permission mask for script files that the server will not serve. For example, to prohibit serving PHP scripts that are group and world writable, set the mask to <span class="val">022</span>. Default value is <span class="val">000</span>.<br/><br/> See <span class="cmd">man 2 stat</span> for all values.</p> <h4>Syntax</h4><p>octal numbers</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#restrictedDirPermissionMask">Script Directory Restricted Permission Mask</a></span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="restrictedDirPermissionMask"><h3>Script Directory Restricted Permission Mask<span class="ls-permlink"><a href="#restrictedDirPermissionMask"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the restricted permission mask of parent directories of script files that the server will not serve. For example, to prohibit serving PHP scripts in a directory that is group and world writable, set the mask to <span class="val">022</span>. Default value is <span class="val">000</span>. This option can be used to prevent serving scripts under a directory of uploaded files.<br/><br/> See <span class="cmd">man 2 stat</span> for all values.</p> <h4>Syntax</h4><p>octal numbers</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#restrictedScriptPermissionMask">Script Restricted Permission Mask</a></span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cgiResource"><h3>CGI Settings<span class="ls-permlink"><a href="#cgiResource"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The following settings control CGI processes. Memory and process limits also serve as the default for other external applications if limits have not been set explicitly for those applications.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cgidSock"><h3>CGI Daemon Socket<span class="ls-permlink"><a href="#cgidSock"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique socket address used to communicate with the CGI daemon. LiteSpeed server uses a standalone CGI daemon to spawn CGI scripts for best performance and security. If you need to change this location, specify a Unix domain socket here.<br/><br/> Default value: <span class="val">uds://$SERVER_ROOT/admin/lscgid/.cgid.sock</span></p> <h4>Syntax</h4><p>UDS://path</p> <h4>Example</h4><div class="ls-example">UDS://tmp/lshttpd/cgid.sock</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxCGIInstances"><h3>Max CGI Instances<span class="ls-permlink"><a href="#maxCGIInstances"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent CGI processes the server can start. For each request to a CGI script, the server needs to start a standalone CGI process. On a Unix system, the number of concurrent processes is limited. Excessive concurrent processes will degrade the performance of the whole system and are one way to perform a DoS attack. LiteSpeed server pipelines requests to CGI scripts and limits concurrent CGI processes to ensure the optimal performance and reliability. The hard limit is <span class="val">2000</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span><span title="Performance" class="ls-icon-performance"></span> A higher limit does not necessarily translate to faster performance. In most cases, a lower limit gives better performance and security. A higher limit will only help when I/O latency is excessive during CGI processing.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="minUID"><h3>Minimum UID<span class="ls-permlink"><a href="#minUID"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the minimum user ID allowed to run external applications when running as a specified user. Execution of an external script with a user ID lower than the value specified here will be denied.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Set it high enough to exclude all system/privileged users.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="minGID"><h3>Minimum GID<span class="ls-permlink"><a href="#minGID"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the minimum group ID allowed to run external applications when running as a specified group. Execution of an external script with a group ID lower than the value specified here will be denied.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Set it high enough to exclude all groups used by system users.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="forceGID"><h3>Force GID<span class="ls-permlink"><a href="#forceGID"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a group ID to be used for all external applications started in suEXEC mode. When set to non-zero value, all suEXEC external applications (CGI/FastCGI/LSAPI) will use this group ID. This can be used to prevent an external application from accessing files owned by other users.<br/><br/> For example, in a shared hosting environment, LiteSpeed runs as user "www-data", group "www-data". Each docroot is owned by a user account, with a group of "www-data" and permission mode 0750. If Force GID is set to "nogroup" (or any group other than 'www-data'), all suEXEC external applications will run as a particular user but in the group "nogroup". These external application processes will still be able to access files owned by that particular user (because of their user ID), but will not have group permission to access anyone else's files. The server, on the other hand, still can serve files under any user's docroot directory (because of its group ID).</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Set it high enough to exclude all groups used by system users.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="umask"><h3>umask<span class="ls-permlink"><a href="#umask"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Sets default umask for CGI processes. See <span class="cmd"> man 2 umask </span> for details. This also serves as the default value for external applications <span class="tagl"><a href="ExtApp_Help.html#extUmask">umask</a></span>.</p> <h4>Syntax</h4><p>value valid range [000]-[777].</p> <h4>See Also</h4><p class="ls-text-small">ExtApp <span class="tagl"><a href="ExtApp_Help.html#extUmask">umask</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="CGIPriority"><h3>CGI Priority<span class="ls-permlink"><a href="#CGIPriority"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies priority of the external application process. Value ranges from <span class="val">-20</span> to <span class="val">20</span>. A lower number means a higher priority.<br/><br/> A CGI process cannot have a higher priority than the web server. If this priority is set to a lower number than the server's, the server's priority will be used for this value.</p> <h4>Syntax</h4><p>int</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#serverPriority">Priority</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="CPUSoftLimit"><h3>CPU Soft Limit (sec)<span class="ls-permlink"><a href="#CPUSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies CPU consumption time limit in seconds for a CGI process. When the process reaches the soft limit, it will be notified by a signal. The operating system's default setting will be used if the value is absent or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="CPUHardLimit"><h3>CPU Hard Limit<span class="ls-permlink"><a href="#CPUHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies maximum CPU consumption time limit in seconds for a CGI process. If the process continues to consume CPU time and reach the hard limit, the process will be force killed. The operating system's default setting will be used if the value is absent or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memSoftLimit"><h3>Memory Soft Limit (bytes)<span class="ls-permlink"><a href="#memSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the memory consumption limit in bytes for an external application process or an external application started by the server.<br/><br/> The main purpose of this limit is to prevent excessive memory usage because of software bugs or intentional attacks, not to impose a limit on normal usage. Make sure to leave enough head room, otherwise your application may fail and 503 error may be returned. It can be set at the server- level or at an individual external application level. The server-level limit will be used if it is not set at the individual application level.<br/><br/> The operating system's default setting will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application needs more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memHardLimit"><h3>Memory Hard Limit (bytes)<span class="ls-permlink"><a href="#memHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#memSoftLimit">Memory Soft Limit (bytes)</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level.<br/><br/> The operating system's default will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application need more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procSoftLimit"><h3>Process Soft Limit<span class="ls-permlink"><a href="#procSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Limits the total number of processes that can be created on behalf of a user. All existing processes will be counted against this limit, not just new processes to be started.<br/><br/> The limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default setting will be used if this value is 0 or absent at both levels.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> To control how many processes LSWS will make for users in mod_suEXEC mode, use the suEXEC Max Conn setting. PHP scripts can call for forking processes and the number of processes needed for normal functioning can be above the suEXEC Max Conn setting. The main purpose of this limit is as a last line of defense to prevent fork bombs and other attacks caused by PHP processes creating other processes.<br/><br/> Setting this setting too low can severely hurt functionality. The setting will thus be ignored below certain levels.<br/><br/> When <b>Run On Start Up</b> is set to "Yes (Daemon mode)", the actual process limit will be higher than this setting to make sure parent processes are not limited.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procHardLimit"><h3>Process Hard Limit<span class="ls-permlink"><a href="#procHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#procSoftLimit">Process Soft Limit</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default value will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cgroups"><h3>cgroups<span class="ls-permlink"><a href="#cgroups"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="lsrecaptcha"><h3>reCAPTCHA Protection<span class="ls-permlink"><a href="#lsrecaptcha"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>reCAPTCHA Protection is a service provided as a way to mitigate heavy server load. reCAPTCHA Protection will activate after one of the below situations is hit. Once active, all requests by NON TRUSTED(as configured) clients will be redirected to a reCAPTCHA validation page. After validation, the client will be redirected to their desired page.<br/><br/> The following situations will activate reCAPTCHA Protection:<br/> 1. The server or vhost concurrent requests count passes the configured connection limit.<br/> 2. Anti-DDoS is enabled and a client is hitting a url in a suspicious manner. The client will redirect to reCAPTCHA first instead of getting denied when triggered.<br/> 3. WordPress Brute Force Attack Protection is enabled and action is set to 'CAPTCHA or Drop’. When a brute force attack is detected, the client will redirect to reCAPTCHA first. After max tries is reached, the connection will be dropped, as per the ‘drop’ option.<br/> 4. WordPress Brute Force Attack Protection is enabled and action is set to 'WP Login CAPTCHA Full Protection'. The client will always redirect to reCAPTCHA first.<br/> 5. A new rewrite rule environment is provided to activate reCAPTCHA via RewriteRules. 'verifycaptcha' can be set to redirect clients to reCAPTCHA. A special value ': deny' can be set to deny the client if it failed too many times. For example, [E=verifycaptcha] will always redirect to reCAPTCHA until verified. [E=verifycaptcha: deny] will redirect to reCAPTCHA until Max Tries is hit, after which the client will be denied.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableRecaptcha"><h3>Enable reCAPTCHA<span class="ls-permlink"><a href="#enableRecaptcha"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enable the reCAPTCHA Protection feature at the current level. This setting must be set to <span class="val">Yes</span> at the Server level before the reCAPTCHA Protection feature can be used.<br/><br/> Default values:<br/> <b>Server-level:</b> <span class="val">No</span><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"><div><header id="recaptchaSiteKey"><h3>Site Key<span class="ls-permlink"><a href="#recaptchaSiteKey"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The site key is the public key provided by Google via its reCAPTCHA service. A default Site Key will be used if not set.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="recaptchaSecretKey"><h3>Secret Key<span class="ls-permlink"><a href="#recaptchaSecretKey"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The secret key is the private key provided by Google via its reCAPTCHA service. A default Secret Key will be used if not set.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="recaptchaType"><h3>reCAPTCHA Type<span class="ls-permlink"><a href="#recaptchaType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specify the reCAPTCHA type to use with the key pairs.<br/> If a key pair has not been provided and this setting is set to <span class="val">Not Set</span>, a default key pair of type <span class="val">Invisible</span> will be used.<br/><br/> <span class="val">Checkbox</span> will display a checkbox reCAPTCHA for the visitor to validate.<br/><br/> <span class="val">Invisible</span> will attempt to validate the reCAPTCHA automatically and if successful, will redirect to the desired page.<br/><br/> <span class="val">hCaptcha</span> can be used to support reCAPTCHA provider <a href="https://www.hcaptcha.com" target="_blank" rel="noopener noreferrer">hCaptcha</a>.<br/><br/> Default value is <span class="val">Invisible</span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="recaptchaSensitivity"><h3>Trigger Sensitivity<span class="ls-permlink"><a href="#recaptchaSensitivity"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Automatic reCAPTCHA sensitivity. The higher the value, the more likely reCAPTCHA Protection will be used. A value of <span class="val">0</span> is equivalent to "Off" while a value of <span class="val">100</span> is equivalent to "Always On".<br/><br/> Default values:<br/> <b>Server level:</b> 0<br/> <b>Virtual Host level:</b> Inherit Server level setting</p> <h4>Syntax</h4><p>Integer value between 0 and 100.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="recaptchaMaxTries"><h3>Max Tries<span class="ls-permlink"><a href="#recaptchaMaxTries"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Max Tries specifies the maximum number of reCAPTCHA attempts permitted before denying the visitor.<br/><br/> Default value is <span class="val">3</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="verifyExpires"><h3>Verification Expires (secs)<span class="ls-permlink"><a href="#verifyExpires"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Sets the expire time of a successful reCAPTCHA submission, after which reCAPTCHA protection will re-trigger for that visitor.<br/><br/> Default value: <span class="val">86,400</span> (1 day).</p> <h4>Syntax</h4><p>Integer value between 30 and 31,536,000 (1 year).</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="recaptchaAllowedRobotHits"><h3>Allowed Robot Hits<span class="ls-permlink"><a href="#recaptchaAllowedRobotHits"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Number of hits per 10 seconds to allow ‘good bots’ to pass. Bots will still be throttled when the server is under load.<br/><br/> Default value is <span class="val">3</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="recaptchaBotWhiteList"><h3>Bot White List<span class="ls-permlink"><a href="#recaptchaBotWhiteList"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>List of custom user agents to allow access. Will be subject to the ‘good bots’ limitations, including allowedRobotHits.</p> <h4>Syntax</h4><p>List of user agents, one per line. Regex is supported.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="bubbleWrap"><h3>Bubblewrap Container<span class="ls-permlink"><a href="#bubbleWrap"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set to <span class="val">Enabled</span> if you wish to start CGI processes (including PHP programs) in a bubblewrap sandbox. See <a href=" https://wiki.archlinux.org/title/Bubblewrap " target="_blank" rel="noopener noreferrer"> https://wiki.archlinux.org/title/Bubblewrap </a> for details on using bubblewrap. Bubblewrap must be installed on your system prior to using this setting.<br/><br/> This setting cannot be turned on at the Virtual Host level if set to "Disabled" at the Server level.<br/><br/> Default values:<br/> <b>Server level:</b> Disabled<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"><div><header id="bubbleWrapCmd"><h3>Bubblewrap Command<span class="ls-permlink"><a href="#bubbleWrapCmd"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The full bubblewrap use command, including the bubblewrap program itself. More on configuring this command can be found here: <a href=" https://docs.litespeedtech.com/products/lsws/bubblewrap " target="_blank" rel="noopener noreferrer"> https://docs.litespeedtech.com/products/lsws/bubblewrap </a>. If not specified, the default command listed below will be used.<br/><br/> Default value: <span class="cmd">/bin/bwrap --ro-bind /usr /usr --ro-bind /lib /lib --ro-bind-try /lib64 /lib64 --ro-bind /bin /bin --ro-bind /sbin /sbin --dir /var --dir /tmp --proc /proc --symlink ../tmp var/tmp --dev /dev --ro-bind-try /etc/localtime /etc/localtime --ro-bind-try /etc/ld.so.cache /etc/ld.so.cache --ro-bind-try /etc/resolv.conf /etc/resolv.conf --ro-bind-try /etc/ssl /etc/ssl --ro-bind-try /etc/pki /etc/pki --ro-bind-try /etc/man_db.conf /etc/man_db.conf --ro-bind-try /home/$USER /home/$USER --bind-try /var/lib/mysql/mysql.sock /var/lib/mysql/mysql.sock --bind-try /home/mysql/mysql.sock /home/mysql/mysql.sock --bind-try /tmp/mysql.sock /tmp/mysql.sock --unshare-all --share-net --die-with-parent --dir /run/user/$UID ‘$PASSWD 65534’ ‘$GROUP 65534’</span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="namespace"><h3>Namespace Container<span class="ls-permlink"><a href="#namespace"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set to <span class="val">Enabled</span> if you wish to start CGI processes (including PHP programs) in a namespace container sandbox. Only used when <span class="tagl"><a href="ServSecurity_Help.html#bubbleWrap">Bubblewrap Container</a></span> is set to <span class="val">Disabled</span>.<br/><br/> When not <span class="val">Disabled</span> at the Server level, this settings value can be overridden at the Virtual Host level.<br/><br/> Default values:<br/> <b>Server level:</b> <span class="val">Disabled</span><br/> <b>Virtual Host 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"><div><header id="namespaceConf"><h3>Namespace Template File<span class="ls-permlink"><a href="#namespaceConf"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Path to an existing configuration file containing a list of directories to be mounted along with the methods used to mount them. When <span class="tagl"><a href="ServSecurity_Help.html#namespace">Namespace Container</a></span> is set to <span class="val">Enabled</span> and this value is not set, the following secure default configuration settings will be used:<br/><br/> <span class="val"> $HOMEDIR/.lsns/tmp /tmp,tmp<br/> /usr,ro-bind<br/> /lib,ro-bind<br/> /lib64,ro-bind-try<br/> /bin,ro-bind<br/> /sbin,ro-bind<br/> /var,dir<br/> /var/www,ro-bind-try<br/> /proc,proc<br/> ../tmp var/tmp,symlink<br/> /dev,dev<br/> /etc/localtime,ro-bind-try<br/> /etc/ld.so.cache,ro-bind-try<br/> /etc/resolv.conf,ro-bind-try<br/> /etc/ssl,ro-bind-try<br/> /etc/pki,ro-bind-try<br/> /etc/man_db.conf,ro-bind-try<br/> /usr/local/bin/msmtp /etc/alternatives/mta,ro-bind-try<br/> /usr/local/bin/msmtp /usr/sbin/exim,ro-bind-try<br/> $HOMEDIR,bind-try<br/> /var/lib/mysql/mysql.sock,bind-try<br/> /home/mysql/mysql.sock,bind-try<br/> /tmp/mysql.sock,bind-try<br/> /run/mysqld/mysqld.sock,bind-try<br/> /var/run/mysqld.sock,bind-try<br/> /run/user/$UID,bind-try<br/> $PASSWD<br/> $GROUP<br/> /etc/exim.jail/$USER.conf $HOMEDIR/.msmtprc,copy-try<br/> /etc/php.ini,ro-bind-try<br/> /etc/php-fpm.conf,ro-bind-try<br/> /etc/php-fpm.d,ro-bind-try<br/> /var/run,ro-bind-try<br/> /var/lib,ro-bind-try<br/> /etc/imunify360/user_config/,ro-bind-try<br/> /etc/sysconfig/imunify360,ro-bind-try<br/> /opt/plesk/php,ro-bind-try<br/> /opt/alt,bind-try<br/> /opt/cpanel,bind-try<br/> /opt/psa,bind-try<br/> /var/lib/php/sessions,bind-try </span></p> <h4>Syntax</h4><p>An absolute path or a relative path to $SERVER_ROOT.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenyDir"><h3>Access Denied Directories<span class="ls-permlink"><a href="#accessDenyDir"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies directories that should be blocked from access. Add directories that contain sensitive data to this list to prevent accidentally exposing sensitive files to clients. Append a "*" to the path to include all sub-directories. If both <span class="tagl"><a href="#followSymbolLink">Follow Symbolic Link</a></span> and <span class="tagl"><a href="#checkSymbolLink">Check Symbolic Link</a></span> are enabled, symbolic links will be checked against the denied directories.</p> <h4>Syntax</h4><p>Comma-delimited list of directories</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Of critical importance: This setting only prevents serving static files from these directories. This does not prevent exposure by external scripts such as PHP/Ruby/CGI.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessControl"><h3>Access Control<span class="ls-permlink"><a href="#accessControl"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what sub networks and/or IP addresses can access the server. At the server level, this setting will affect all virtual hosts. You can also set up access control unique to each virtual host at the virtual host level. Virtual host level settings will NOT override server level settings.<br/><br/> Blocking/Allowing an IP is determined by the combination of the allowed list and the denied list. If you want to block only certain IPs or sub-networks, put <span class="val">*</span> or <span class="val">ALL</span> in the <span class="tagl"><a href="#accessControl_allow">Allowed List</a></span> and list the blocked IPs or sub-networks in the <span class="tagl"><a href="#accessControl_deny">Denied List</a></span>. If you want to allow only certain IPs or sub-networks, put <span class="val">*</span> or <span class="val">ALL</span> in the <span class="tagl"><a href="#accessControl_deny">Denied List</a></span> and list the allowed IPs or sub-networks in the <span class="tagl"><a href="#accessControl_allow">Allowed List</a></span>. The setting of the smallest scope that fits for an IP will be used to determine access.<br/><br/> <b>Server Level:</b> Trusted IPs or sub-networks must be specified in the <span class="tagl"><a href="#accessControl_allow">Allowed List</a></span> by adding a trailing "T". Trusted IPs or sub-networks are not affected by connection/throttling limits. Only server level access control can set up trusted IPs/sub-networks.</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Use this at the server level for general restrictions that apply to all virtual hosts.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessControl_allow"><h3>Allowed List<span class="ls-permlink"><a href="#accessControl_allow"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the list of IPs or sub-networks allowed. <span class="val">*</span> or <span class="val">ALL</span> are accepted.</p> <h4>Syntax</h4><p>Comma delimited list of IP addresses or sub-networks. A trailing "T" can be used to indicate a trusted IP or sub-network, such as <span class="val">192.168.1.*T</span>.</p> <h4>Example</h4><div class="ls-example"><b>Sub-networks:</b> 192.168.1.0/255.255.255.0, 192.168.1.0/24, 192.168.1, or 192.168.1.*<br/> <b>IPv6 addresses:</b> ::1 or [::1]<br/> <b>IPv6 subnets:</b> 3ffe:302:11:2:20f:1fff:fe29:717c/64 or [3ffe:302:11:2:20f:1fff:fe29:717c]/64</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks set at the server level access control will be excluded from connection/throttling limits.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessControl_deny"><h3>Denied List<span class="ls-permlink"><a href="#accessControl_deny"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the list of IPs or sub-networks disallowed.</p> <h4>Syntax</h4><p>Comma delimited list of IP addresses or sub-networks. <span class="val">*</span> or <span class="val">ALL</span> are accepted.</p> <h4>Example</h4><div class="ls-example"><b>Sub-networks:</b> 192.168.1.0/255.255.255.0, 192.168.1.0/24, 192.168.1, or 192.168.1.*<br/> <b>IPv6 addresses:</b> ::1 or [::1]<br/> <b>IPv6 subnets:</b> 3ffe:302:11:2:20f:1fff:fe29:717c/64 or [3ffe:302:11:2:20f:1fff:fe29:717c]/64</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
ServerStat_Help.html 0000644 00000053252 15055121352 0010512 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - WebAdmin Console - Service Manager</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - WebAdmin Console - Service Manager." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu level2">
<li><span class="current"><a href="ServerStat_Help.html">Service Manager</a></span></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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev"> </div><div class="center"><a href="admin.html">Administration</a></div><div class="next"><a href="Real_Time_Stats_Help.html">Real-Time Statistics</a> »</div></div>
<h1>WebAdmin Console - Service Manager</h1><section class="ls-spacer-small-bottom">The Service Manager acts as a control room for monitoring the server and controlling certain
top-level functions. It provides the following features:
(The Service Manager can be accessed by clicking on the Actions menu or from home page.)
<ul>
<li>Monitor the current status of the server, listeners, and virtual hosts.</li>
<li>Apply configuration changes with a graceful restart.</li>
<li>Enable or disable a particular virtual host.</li>
<li>View the server log through the log viewer.</li>
<li>Monitor real-time server statistics.</li>
<li>Download new versions or switch between installed versions.</li>
</ul></section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Server</header><p>
<a href="#sname">Name - Server</a> | <a href="#pid">PID</a> | <a href="#servAction">Actions</a> | <a href="#restart">Apply Changes/Graceful Restart</a> | <a href="#viewlog">Server Log Viewer</a> | <a href="#realtimerpt">Real-Time Statistics</a> | <a href="#toggleDebugLog">Toggle Debug Logging</a> | <a href="#vermgr">Version Management</a></p></section>
<section class="toc-row"><header>Listeners</header><p>
<a href="#lname">Name - Listener</a> | <a href="#lstatus">Status - Listener</a> | <a href="#lmap">Virtual Hosts Mappings</a></p></section>
<section class="toc-row"><header>Virtual Hosts</header><p>
<a href="#vname">Name - Virtual Host</a> | <a href="#vstatus">Status - Virtual Host</a> | <a href="#vaction">Actions - Virtual Host</a> | <a href="#venable">Enable</a> | <a href="#vdisable">Disable</a> | <a href="#vreload">Restart - Virtual Host</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="sname"><h3>Name - Server<span class="ls-permlink"><a href="#sname"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The unique name that identifies this server. This is the <span class="tagl"><a href="ServGeneral_Help.html#serverName">Server Name</a></span> specified in the general configuration.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pid"><h3>PID<span class="ls-permlink"><a href="#pid"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>PID (Process ID) of the current server process.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> The PID will change each time the server is restarted.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="servAction"><h3>Actions<span class="ls-permlink"><a href="#servAction"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Six actions are available from this menu: <span class="val">Graceful Restart</span>, <span class="val">Toggle Debug Logging</span>, <span class="val">Server Log Viewer</span>, <span class="val">Real-Time Statistics</span>, <span class="val">Version Manager</span>, and <span class="val">Compile PHP</span>. <ul><li><span class="tagl"><a href="#restart">Apply Changes/Graceful Restart</a></span> restarts server process gracefully without interrupting requests in process.</li> <li><span class="tagl"><a href="#toggleDebugLog">Toggle Debug Logging</a></span> turns debug logging on or off.</li> <li><span class="tagl"><a href="#viewlog">Server Log Viewer</a></span> allows you to view the server log through the log viewer.</li> <li><span class="tagl"><a href="#realtimerpt">Real-Time Statistics</a></span> allows you to view real-time server status.</li> <li><span class="tagl"><a href="#vermgr">Version Management</a></span> allows you to download new versions of LSWS and switch between different versions. <li>Compile PHP allows you to compile PHP for LiteSpeed Web Server. </ul></p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> The shell utility <span class="cmd">$SERVER_ROOT/bin/lswsctrl</span> can be used to control the server processes as well, but requires a login shell.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="restart"><h3>Apply Changes/Graceful Restart<span class="ls-permlink"><a href="#restart"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>By clicking <span class="val">Graceful Restart</span>, a new server process will be started. For <span class="val">Graceful Restart</span>, the old server process will only exit after all requests to it have been finished (or the <span class="tagl"><a href="#gracefulRestartTimeout">Graceful Restart Timeout (secs)</a></span> limit has been reached). Configuration changes are applied at the next restart. <span class="val">Graceful Restart</span> will apply these changes without any server downtime.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Graceful restart takes less than 2 seconds to generate a new server process.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="viewlog"><h3>Server Log Viewer<span class="ls-permlink"><a href="#viewlog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The Server Log Viewer is a convenient tool for browsing the current server log to check for errors or problems. The log viewer searches the server log file in blocks for the specified log level. The default block size is 20KB. You can use the <span class="val">Begin</span>, <span class="val">End</span>, <span class="val">Next</span>, and <span class="val">Prev</span> buttons to navigate a large log file.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> The size of a dynamically generated page is limited by <span class="tagl"><a href="ServTuning_Help.html#maxDynRespSize">Max Dynamic Response Body Size (bytes)</a></span>. So if the block is too big, the page might be truncated.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realtimerpt"><h3>Real-Time Statistics<span class="ls-permlink"><a href="#realtimerpt"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The Real-Time Statistics link leads to a page with a real-time server status report. This is a convenient tool to monitor the system. The report shows a snapshot of your server statistics. The refresh rate for this snapshot is controlled by the Refresh Interval drop-down list in the upper righthand corner. The report contains the following sections: <ul><li>Server Health shows the basic server statistics, uptime, load, and anti-DDoS blocked IPs.</li> <li>Server lists current traffic throughput, connections, and requests statistics.</li> <li>Virtual Host shows request processing statuses and external application statuses for each virtual host.</li> <li>External Application lists the external applications currently running and their usage statistics. The CGI daemon process lscgid is always running as an external application.</li> </ul> Many of the rows in the Real-Time Statistics feature a graph icon. Clicking on this icon will open a graph of that row's statistics updated in real-time. In the Server section, next to Requests, there is a link labeled (Details). This link takes you to the Requests Snapshot, where you can view detailed information on which clients are making certain kinds of requests or which aspects of your site are bottlenecking. The fields in the blue area allow you to filter the snapshot to isolate certain parts of your server or look for clients that are performing certain actions.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="toggleDebugLog"><h3>Toggle Debug Logging<span class="ls-permlink"><a href="#toggleDebugLog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Toggle Debug Logging toggles the value of <span class="tagl"><a href="ServGeneral_Help.html#log_debugLevel">Debug Level</a></span> between <span class="val">NONE</span> and <span class="val">HIGH</span>. As debug logging has an impact on performance and can fill up the hard drive quickly, so <span class="tagl"><a href="ServGeneral_Help.html#log_debugLevel">Debug Level</a></span> should usually be set to <span class="val">NONE</span> on a production server. This feature can be used instead to turn debug logging on and off quickly in order to debug a problem on a production server. Debug logging turned on or off in this way will not change anything shown in your server configurations.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> <span class="tagl"><a href="#toggleDebugLog">Toggle Debug Logging</a></span> will only work if <span class="tagl"><a href="ServGeneral_Help.html#log_logLevel">Log Level</a></span> is set to <span class="val">DEBUG</span>. <span title="Performance" class="ls-icon-performance"></span> Important! Debug logging includes detailed information for each request and response. Active debug logging will severely degrade service performance and potentially saturate disk space in a very short time. This feature should only be used for a short period of time when trying to diagnose server issues.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="ServGeneral_Help.html#log_debugLevel">Debug Level</a></span>, <span class="tagl"><a href="ServGeneral_Help.html#log_logLevel">Log Level</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vermgr"><h3>Version Management<span class="ls-permlink"><a href="#vermgr"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Version Management (found by clicking on the the version number at the top of the page) is a convenient tool to manage LSWS versions. It shows license info and information on all installed versions and available new releases. <ul><li>If a new version has been released on the LiteSpeed website, and <span class="tagl"><a href="ServGeneral_Help.html#autoUpdateInterval">Check For Update</a></span> is enabled, the new version will be listed with a <span class="val">Download</span> link. If <span class="tagl"><a href="ServGeneral_Help.html#autoUpdateDownloadPkg">Download Updates</a></span> is enabled, new versions will be automatically downloaded and the new version will be listed with an <span class="val">Upgrade</span> link. Upgrade installs the new package and restarts the web server. </li> <li>You return to a previous version by clicking the <span class="val">Switch To</span> link. This will restart the web server with that version.</li> <li>If you are sure that you no longer need an old installation, you can remove it by clicking the <span class="val">Delete</span> link. This will permanently remove that copy.</li></ul> Please note, service will not be interrupted during an upgrade or restart.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="ServGeneral_Help.html#autoUpdateDownloadPkg">Download Updates</a></span>, <span class="tagl"><a href="ServGeneral_Help.html#autoUpdateInterval">Check For Update</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="lname"><h3>Name - Listener<span class="ls-permlink"><a href="#lname"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The unique name that identifies this listener. This is the <span class="tagl"><a href="Listeners_General_Help.html#listenerName">Listener Name</a></span> you specified when setting up the listener.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="lstatus"><h3>Status - Listener<span class="ls-permlink"><a href="#lstatus"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The current status of this listener. The status is either <span class="val">Running</span> or <span class="val">Error</span>.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> If the listener is in the <span class="val">Error</span> state, you can view the server log to find out why.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="lmap"><h3>Virtual Hosts Mappings<span class="ls-permlink"><a href="#lmap"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Shows currently established mappings to virtual hosts from a particular listener. The virtual host name appears in brackets and is followed by the matching domain name(s) for this listener.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> If a virtual host has not been loaded successfully (fatal errors in the virtual host configuration), the mapping to that virtual host will not be displayed.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vname"><h3>Name - Virtual Host<span class="ls-permlink"><a href="#vname"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The unique name that identifies this virtual host. This is the <span class="tagl"><a href="VirtualHosts_Help.html#vhName">Virtual Host Name</a></span> you specified when setting up this virtual host.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vstatus"><h3>Status - Virtual Host<span class="ls-permlink"><a href="#vstatus"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The current status of a virtual host. The status can be: <span class="val">Running</span>, <span class="val">Stopped</span>, <span class="val">Restart Required</span>, or <span class="val">Running - Removed from Configuration</span>. <ul> <li><span class="val">Running</span> means the virtual host is loaded and in service.</li> <li><span class="val">Stopped</span> means the virtual host is loaded but not in service (disabled). </li> <li><span class="val"> Restart Required</span> means this is a newly added virtual host and the server has not yet loaded its configuration. </li> <li><span class="val">Running - Removed from Configuration</span> means the virtual host has been deleted from the server's configuration but it is still in service. </li> </ul></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vaction"><h3>Actions - Virtual Host<span class="ls-permlink"><a href="#vaction"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>This field shows buttons to disable, enable, or restart the virtual host. Actions taken on one virtual host do not affect the rest of the web server.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> It is good idea to disable a virtual host temporarily when updating its content.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="venable"><h3>Enable<span class="ls-permlink"><a href="#venable"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The <span class="val">Enable</span> action starts up a stopped virtual host. This allows new requests to be accepted.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vdisable"><h3>Disable<span class="ls-permlink"><a href="#vdisable"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The <span class="val">Disable</span> action stops a running virtual host. New requests will not be accepted, but requests being processed will finish as usual.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vreload"><h3>Restart - Virtual Host<span class="ls-permlink"><a href="#vreload"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The Restart action causes the web server to load the newest configuration for this virtual host. Requests being processed will finish with the old configuration. The new configuration will only apply for new requests. All changes to a virtual host can be applied on the fly this way.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
App_Server_Help.html 0000644 00000064237 15055121352 0010463 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - App Server Settings</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - App Server Settings." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><span class="current"><a href="App_Server_Help.html">App Server Settings</a></span></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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="PHP_Help.html">PHP</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>
<h1>App Server Settings</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#railsDefaults">Rack/Rails Default Settings</a></header><p>
<a href="#rubyBin">Ruby Path</a> | <a href="#appserverEnv">Run-Time Mode</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#pcKeepAliveTimeout">Connection Keepalive Timeout</a> | <a href="#respBuffer">Response Buffering</a> | <a href="#extMaxIdleTime">Max Idle Time</a> | <a href="#backlog">Back Log</a> | <a href="#runOnStartUp">Run On Start Up</a> | <a href="#extAppPriority">Priority</a> | <a href="#memSoftLimit">Memory Soft Limit (bytes)</a> | <a href="#memHardLimit">Memory Hard Limit (bytes)</a> | <a href="#procSoftLimit">Process Soft Limit</a> | <a href="#procHardLimit">Process Hard Limit</a></p></section>
<section class="toc-row"><header><a href="#railsHosting">Rack/Rails Shared Hosting</a></header><p>
<a href="#enableRailsHosting">Enable Shared Hosting</a> | <a href="#railsAppLimit">Max Apps Per Account</a> | <a href="#rubyProcLimit">Max Ruby Processes Per Account</a></p></section>
<section class="toc-row"><header><a href="#wsgiDefaults">Python WSGI Default Settings</a></header><p>
<a href="#wsgiBin">WSGI Path</a> | <a href="#appserverEnv">Run-Time Mode</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#pcKeepAliveTimeout">Connection Keepalive Timeout</a> | <a href="#respBuffer">Response Buffering</a> | <a href="#extMaxIdleTime">Max Idle Time</a> | <a href="#backlog">Back Log</a> | <a href="#runOnStartUp">Run On Start Up</a> | <a href="#extAppPriority">Priority</a> | <a href="#memSoftLimit">Memory Soft Limit (bytes)</a> | <a href="#memHardLimit">Memory Hard Limit (bytes)</a> | <a href="#procSoftLimit">Process Soft Limit</a> | <a href="#procHardLimit">Process Hard Limit</a></p></section>
<section class="toc-row"><header><a href="#nodeDefaults">Node.js App Default Settings</a></header><p>
<a href="#nodeBin">Node Path</a> | <a href="#appserverEnv">Run-Time Mode</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#pcKeepAliveTimeout">Connection Keepalive Timeout</a> | <a href="#respBuffer">Response Buffering</a> | <a href="#extMaxIdleTime">Max Idle Time</a> | <a href="#backlog">Back Log</a> | <a href="#runOnStartUp">Run On Start Up</a> | <a href="#extAppPriority">Priority</a> | <a href="#memSoftLimit">Memory Soft Limit (bytes)</a> | <a href="#memHardLimit">Memory Hard Limit (bytes)</a> | <a href="#procSoftLimit">Process Soft Limit</a> | <a href="#procHardLimit">Process Hard Limit</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="railsDefaults"><h3>Rack/Rails Default Settings<span class="ls-permlink"><a href="#railsDefaults"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Default configurations for Rack/Rails applications. These settings can be overriden at the context level.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rubyBin"><h3>Ruby Path<span class="ls-permlink"><a href="#rubyBin"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Path to Ruby executable. Generally, it is /usr/bin/ruby or /usr/local/bin/ruby depending on where Ruby has been installed to.</p> <h4>Syntax</h4><p>Absolute path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="appserverEnv"><h3>Run-Time Mode<span class="ls-permlink"><a href="#appserverEnv"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which mode the application will be running as: "Development", "Production", or "Staging". The default is "Production".</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="initTimeout"><h3>Initial Request Timeout (secs)<span class="ls-permlink"><a href="#initTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds the server will wait for the external application to respond to the first request over a new established connection. If the server does not receive any data from the external application within this timeout limit, it will mark this connection as bad. This helps to identify communication problems with external applications as quickly as possible. If some requests take longer to process, increase this limit to avoid 503 error messages.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="retryTimeout"><h3>Retry Timeout (secs)<span class="ls-permlink"><a href="#retryTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the period of time that the server waits before retrying an external application that had a prior communication problem.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pcKeepAliveTimeout"><h3>Connection Keepalive Timeout<span class="ls-permlink"><a href="#pcKeepAliveTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds to keep an idle persistent connection open.<br/><br/> When set to "-1", the connection will never timeout. When set to 0 or greater, the connection will be closed after this time in seconds has passed.</p> <h4>Syntax</h4><p>int</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="respBuffer"><h3>Response Buffering<span class="ls-permlink"><a href="#respBuffer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to buffer responses received from external applications. If a "nph-" (Non-Parsed-Header) script is detected, buffering is turned off for responses with full HTTP headers.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extMaxIdleTime"><h3>Max Idle Time<span class="ls-permlink"><a href="#extMaxIdleTime"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum idle time before an external application is stopped by the server, freeing idle resources. When set to "-1", the external application will not be stopped by the server unless running in ProcessGroup mode where idle external applications will be stopped after 30 seconds.<br/><br/> Default value: <span class="val">-1{/val}</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> This feature is especially useful in the mass hosting environment where, in order to prevent files owned by one virtual host from being accessed by the external application scripts of another virtual host, many different applications are run at the same time in SetUID mode. Set this value low to prevent these external applications from idling unnecessarily.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="backlog"><h3>Back Log<span class="ls-permlink"><a href="#backlog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the backlog of the listening socket. Required if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="runOnStartUp"><h3>Run On Start Up<span class="ls-permlink"><a href="#runOnStartUp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to start the external application at server start up. Only applicable to external applications that can manage their own child processes and where <span class="tagl"><a href="#instances">Instances</a></span> value is set to "1".<br/><br/> If enabled, external processes will be created at server startup instead of run-time.<br/><br/> When selecting "Yes (Detached mode)", all detached process can be restarted at the Server level or Virtual Host level by touching the '.lsphp_restart.txt' file under the $SERVER_ROOT/admin/tmp/ or $VH_ROOT/ directory respectively.<br/><br/> Default value: Yes (Detached mode)</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If the configured external process has significant startup overhead, like a Rails app, then this option should be enabled to decrease first page response time.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPriority"><h3>Priority<span class="ls-permlink"><a href="#extAppPriority"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies priority of the external application process. Value ranges from <span class="val">-20</span> to <span class="val">20</span>. A lower number means a higher priority. An external application process cannot have a higher priority than the web server. If this priority is set to a lower number than the server's, the server's priority will be used for this value.</p> <h4>Syntax</h4><p>int</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#serverPriority">Priority</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memSoftLimit"><h3>Memory Soft Limit (bytes)<span class="ls-permlink"><a href="#memSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the memory consumption limit in bytes for an external application process or an external application started by the server.<br/><br/> The main purpose of this limit is to prevent excessive memory usage because of software bugs or intentional attacks, not to impose a limit on normal usage. Make sure to leave enough head room, otherwise your application may fail and 503 error may be returned. It can be set at the server- level or at an individual external application level. The server-level limit will be used if it is not set at the individual application level.<br/><br/> The operating system's default setting will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application needs more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memHardLimit"><h3>Memory Hard Limit (bytes)<span class="ls-permlink"><a href="#memHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#memSoftLimit">Memory Soft Limit (bytes)</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level.<br/><br/> The operating system's default will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application need more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procSoftLimit"><h3>Process Soft Limit<span class="ls-permlink"><a href="#procSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Limits the total number of processes that can be created on behalf of a user. All existing processes will be counted against this limit, not just new processes to be started.<br/><br/> The limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default setting will be used if this value is 0 or absent at both levels.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> To control how many processes LSWS will make for users in mod_suEXEC mode, use the suEXEC Max Conn setting. PHP scripts can call for forking processes and the number of processes needed for normal functioning can be above the suEXEC Max Conn setting. The main purpose of this limit is as a last line of defense to prevent fork bombs and other attacks caused by PHP processes creating other processes.<br/><br/> Setting this setting too low can severely hurt functionality. The setting will thus be ignored below certain levels.<br/><br/> When <b>Run On Start Up</b> is set to "Yes (Daemon mode)", the actual process limit will be higher than this setting to make sure parent processes are not limited.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procHardLimit"><h3>Process Hard Limit<span class="ls-permlink"><a href="#procHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#procSoftLimit">Process Soft Limit</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default value will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="railsHosting"><h3>Rack/Rails Shared Hosting<span class="ls-permlink"><a href="#railsHosting"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>LiteSpeed's Rack/Rails Shared Hosting settings allow users using our high performance, highly scalable Ruby LSAPI module to easily control their customers' Ruby usage.<br/><br/> LiteSpeed Rack/Rails hosting solution can deliver the best performance with minimum server resource requirement. In addition, it is compatible with all existing web hosting control panels. <br/><br/> The user-manageable Rack/Rails configuration file (".ls_rails_config") is located in the user's home directory or virtual host root directory. Syntax is as follows: <br/> <blockquote> #RailsApp <name> <App Path> <Rails Evn> <Children Processes> <RunOnStart><br/> RailsApp testApp "/lsws/testrails" "development" 4 1 <br/><br/> #RailsAppMap <name> <domain> <URI> <br/> RailsAppMap testApp "testrails.com" "/" <br/> RailsAppMap testApp "test.testrails.com" "/" </blockquote><br/> The "App Path" is relative to the user's home directory or the virtual host root directory.<br/><br/> Whenever this file is touched, Rack/Rails applications will be restarted.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableRailsHosting"><h3>Enable Shared Hosting<span class="ls-permlink"><a href="#enableRailsHosting"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable Rack/Rails shared hosting. The default is "Disabled".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="railsAppLimit"><h3>Max Apps Per Account<span class="ls-permlink"><a href="#railsAppLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of Rack/Rails applications that can be created per account. The default is "1".</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Rack/Rails applications can take a large amount of system resources. Thus it is not recommended to set this limit too high, otherwise it may affect the performance of whole server if one user abuses it.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rubyProcLimit"><h3>Max Ruby Processes Per Account<span class="ls-permlink"><a href="#rubyProcLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of Ruby processes that can be created per account. The default is "10". If one account runs multiple Rack/Rails applications, the total number of Ruby processes of all applications cannot exceed this limit. Each ruby process will take large amount of system resource, it is not recommended to set a high limit, otherwise, it will affect the performance of whole server if one user abuse it.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Ruby processes can take a large amount of system resources. Thus it is not recommended to set this limit too high, otherwise it may affect the performance of the whole server if one user abuses it.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="wsgiDefaults"><h3>Python WSGI Default Settings<span class="ls-permlink"><a href="#wsgiDefaults"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Default configurations for Python WSGI applications. These settings can be overriden at the context level.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="wsgiBin"><h3>WSGI Path<span class="ls-permlink"><a href="#wsgiBin"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Path to LiteSpeed Python Web Server Gateway Interface executable (lswsgi).<br/><br/> This executable is created by compiling Python with LiteSpeed's WSGI LSAPI module.</p> <h4>Syntax</h4><p>Absolute path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="nodeDefaults"><h3>Node.js App Default Settings<span class="ls-permlink"><a href="#nodeDefaults"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Default configurations for Node.js applications. These settings can be overriden at the context level.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="nodeBin"><h3>Node Path<span class="ls-permlink"><a href="#nodeBin"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Path to Node.js executable.</p> <h4>Syntax</h4><p>Absolute path</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
admin.html 0000644 00000017534 15055121352 0006533 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Administration</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Administration." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<span class="current"><a href="admin.html">Administration</a></span>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="install.html">Installation</a></div><div class="center"><a href="index.html">Home</a></div><div class="next"><a href="security.html">Security</a> »</div></div>
<h1>Administration</h1>
<p>LiteSpeed web server can be controlled in three ways: through the WebAdmin interface, from the command line, or by sending signals.</p>
<ol>
<li><h3>Through the WebAdmin console:</h3>
<p>WebAdmin console is a centralized control panel to control and configure all LiteSpeed Web Server settings.</p>
<p>Log on to the WebAdmin console (by default http://[your site's address]:7080/).
Select "Service Manager". Here you will find a control panel with links to perform common tasks:
server restart, server configuration reload, version management, log viewing, real-time monitoring,
virtual host reload, and virtual host enable/disable.</p>
<p><strong>More details on how to control LiteSpeed Web Server through the WebAdmin console - <a href="ServerStat_Help.html">Service Manager</a></strong></p>
<p>To change the login name and password for the WebAdmin interface, run the following command from the shell:<br>
<span class="cmd">[your install dir]/admin/misc/admpass.sh</span> </p>
</li>
<li><h3>Through the command line interface:</h3>
<p>Assuming the web server is installed at /usr/local/lsws.</p>
<p>Use the <span class="tag">lswsctrl</span> control script in /usr/local/lsws/bin/ directory.</p>
<p>To start the web server:<br>
<span class="cmd">/usr/local/lsws/bin/lswsctrl start</span>
</p>
<p>To stop the web server:<br>
<span class="cmd">/usr/local/lsws/bin/lswsctrl stop</span>
</p>
<p>To restart the web server:<br>
<span class="cmd">/usr/local/lsws/bin/lswsctrl restart</span>
</p>
<p>To reload the configuration:<br>
<span class="cmd">/usr/local/lsws/bin/lswsctrl reload</span>
</p>
</li>
<li><h3>By sending signals:</h3>
<p>You can stop server processes and reload configurations by sending signals to the server processes.</p>
<p>First, you need to know the server's process ID, either from the PID file or by running a "ps" command.</p>
<p>To read the PID file:<br>
<span class="cmd">cat /tmp/lshttpd/lshttpd.pid</span></p>
<p>By running a "ps" command:<br>
FreeBSD: <span class="cmd">ps -x | grep lshttpd</span><br>
Others: <span class="cmd">ps -ef | grep lshttpd</span><br>
<br>
If multiple processes are listed, use the process with PPID equal to 1.
</p>
<p>To stop the web server:
<span class="cmd">kill XXXX</span>
(XXXX is the PID)<br>
If the server did not stop, use:
<span class="cmd">kill -9 XXXX</span>
</p>
<p>To reload the configurations, use:
<span class="cmd">kill -HUP XXXX</span>
</p>
</li>
</ol>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Real_Time_Stats_Help.html 0000644 00000015767 15055121352 0011440 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Real-Time Statistics</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Real-Time Statistics." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu level2">
<li><a href="ServerStat_Help.html">Service Manager</a></li>
<li><span class="current"><a href="Real_Time_Stats_Help.html">Real-Time Stats</a></span></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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="ServerStat_Help.html">WebAdmin Console - Service Manager</a></div><div class="center"><a href="admin.html">Administration</a></div><div class="next"> </div></div>
<h1>Real-Time Statistics</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Server Health</header><p>
<a href="#antiddos_blocked_ip">Anti-DDoS Blocked IP</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="antiddos_blocked_ip"><h3>Anti-DDoS Blocked IP<span class="ls-permlink"><a href="#antiddos_blocked_ip"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A comma-separated list of IP addresses blocked by Anti-DDoS protection, each ending with a semi-colon and reason code indicating why the IP address was blocked.<br/><br/> Potential Reason Codes: <ul> <li><span class="val">A</span>: BOT_UNKNOWN</li> <li><span class="val">B</span>: BOT_OVER_SOFT</li> <li><span class="val">C</span>: BOT_OVER_HARD</li> <li><span class="val">D</span>: BOT_TOO_MANY_BAD_REQ</li> <li><span class="val">E</span>: BOT_TOO_MANY_DOS_URL</li> <li><span class="val">F</span>: BOT_CAPTCHA</li> <li><span class="val">G</span>: BOT_FLOOD</li> <li><span class="val">H</span>: BOT_REWRITE_RULE</li> <li><span class="val">I</span>: BOT_TOO_MANY_BAD_STATUS</li> <li><span class="val">J</span>: BOT_WAF_DETECTED</li> <li><span class="val">K</span>: BOT_BRUTE_FORCE</li> </ul><br/><br/> The full list of blocked IPs is also available in the Real-Time Stats report file <span class="val">/tmp/lshttpd/.rtreport</span>.</p> <h4>Syntax</h4><p><blocked_ip_address>;<reason_code></p> <h4>Example</h4><div class="ls-example">1.0.100.50;E, 1.0.100.60;D, 1.0.100.70;F</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
ScriptHandler_Help.html 0000644 00000023355 15055121352 0011153 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Script Handler</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Script Handler." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><span class="current"><a href="ScriptHandler_Help.html">Script Handler</a></span></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="ExtApp_Help.html">External Apps</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="PHP_Help.html">PHP</a> »</div></div>
<h1>Script Handler</h1><section class="ls-spacer-small-bottom">LiteSpeed Web Server supports all scripting languages including
Perl, PHP, Ruby, Python, Java, etc. Scripts written in these different
languages must be brought to the appropriate external application to be processed.
LiteSpeed Web Server uses script handlers to decide which external application a
script should go to. These script handlers map files to external applications by
using the file suffix. (Actually, the suffix is used to determine a MIME
type which is then mapped to the external application.) External applications
must be set up in the External Application tab before they can be selected for
use in a script handler.
<br /><br />
You can set up script handler at the server or virtual host level. Server-level
script handlers apply to all virtual hosts unless overridden in virtual host level.
Virtual host-level script handlers only apply within that virtual host.</section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Script Handler Definition</header><p>
<a href="#suffix">Suffix</a> | <a href="#shType">Handler Type</a> | <a href="#shHandlerName">Handler Name</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="suffix"><h3>Suffix<span class="ls-permlink"><a href="#suffix"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></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 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. You can thus use the Apache configuration directives "AddType" and "ForceType" (which control file MIME types) in .htaccess files to change which script handler certain files will use. For example, with the directive <span class="cmd"> AddType application/x-httpd-php53 .php</span> in a properly placed .htaccess file, you can stipulate that php files in this directory have the MIME type "application/x-httpd-php53" and thus will be handled by the script handler that uses MIME type "application/x-httpd-php53" (suffix "php53"). This then allows you to assign different script handlers, not only for different file suffixes, but also based on the locations of files.<br/> <span title="Performance" class="ls-icon-performance"></span><span title="Security" class="ls-icon-security"></span> Only specify the suffixes you really need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="shType"><h3>Handler Type<span class="ls-permlink"><a href="#shType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the type of external application that processes these script files. Available types are: <span class="val">CGI</span>, <span class="val">FastCGI</span>, <span class="val">Web Server</span>, <span class="val">LSAPI app</span>, <span class="val">Load balancer</span>, or <span class="val">Servlet Engine</span>. For FastCGI, Web Server and Servlet Engine, a <span class="tagl"><a href="#shHandlerName">Handler Name</a></span> needs to be specified. This is an external application name as predefined 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"><div><header id="shHandlerName"><h3>Handler Name<span class="ls-permlink"><a href="#shHandlerName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the external application that processes the script files when the handler type is FastCGI, Web Server, LSAPI, Load Balancer, or Servlet Engine.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
PHP_Help.html 0000644 00000061101 15055121352 0007027 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - PHP</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - PHP." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><span class="current"><a href="PHP_Help.html">PHP</a></span></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="ScriptHandler_Help.html">Script Handler</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="App_Server_Help.html">App Server Settings</a> »</div></div>
<h1>PHP</h1><section class="ls-spacer-small-bottom">The following settings provide an easier way to configure PHP handlers than the older External App + Script Handler
method. If the older configuration already exists, it will continue to work.
<br /><br />
LiteSpeed will also attempt to automatically detect PHP handlers for popular control panel environments. As such you may
not need to configure PHP handlers at all.</section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>PHP Global Configuration</header><p>
<a href="#detachedMode">Detached Mode</a> | <a href="#defaultPhpVer">Default PHP Versions</a> | <a href="#controlPanel">Control Panel</a> | <a href="#clAltPhp">CloudLinux Alt PHP</a> | <a href="#phpSuexecSuffixes">SuEXEC handlers</a></p></section>
<section class="toc-row"><header><a href="#phpHandlerDef">PHP Handler Definition</a></header><p>
<a href="#id">Handler ID</a> | <a href="#phpCommand">Command</a> | <a href="#phpSuffixes">Handled suffixes</a></p></section>
<section class="toc-row"><header><a href="#phpDefault">PHP Handler Defaults</a></header><p>
<a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#pcKeepAliveTimeout">Connection Keepalive Timeout</a> | <a href="#respBuffer">Response Buffering</a> | <a href="#backlog">Back Log</a> | <a href="#runOnStartUp">Run On Start Up</a> | <a href="#extMaxIdleTime">Max Idle Time</a> | <a href="#extAppPriority">Priority</a> | <a href="#memSoftLimit">Memory Soft Limit (bytes)</a> | <a href="#memHardLimit">Memory Hard Limit (bytes)</a> | <a href="#procSoftLimit">Process Soft Limit</a> | <a href="#procHardLimit">Process Hard Limit</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="detachedMode"><h3>Detached Mode<span class="ls-permlink"><a href="#detachedMode"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Run PHP handler processes detached from the main LiteSpeed worker process.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> This has the advantage of allowing LiteSpeed to continue using detached PHP handler processes after restarting as opposed to having to start new PHP handler processes.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultPhpVer"><h3>Default PHP Versions<span class="ls-permlink"><a href="#defaultPhpVer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A list of PHP versions to use as the default ".php" handler when a ".php" handler has not been explicitly set through a script handler or the "Handled suffixes" configuration.<br/><br/> The first available PHP handler, based on this list, will be used.</p> <h4>Syntax</h4><p>Comma separated list of phpXX versions where XX is the combined major and minor PHP version number.</p> <h4>Example</h4><div class="ls-example">php74, php73, php72, php71, php70, php56</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> All versions from php52 to php56 and php70 to php74 are available.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="controlPanel"><h3>Control Panel<span class="ls-permlink"><a href="#controlPanel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Auto detect PHP handlers based on the control panel used.<br/><br/> Default value is "auto detect".</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="clAltPhp"><h3>CloudLinux Alt PHP<span class="ls-permlink"><a href="#clAltPhp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Detect cloudlinux alt PHP handlers.<br/><br/> Default value is "Yes".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="phpSuexecSuffixes"><h3>SuEXEC handlers<span class="ls-permlink"><a href="#phpSuexecSuffixes"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>List of file suffixes associated with handlers in suEXEC mode. All automatically discovered PHP handlers are in suEXEC mode.</p> <h4>Syntax</h4><p>Comma separated list of file suffixes</p> <h4>Example</h4><div class="ls-example">php, php5, php7</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting can be left as "Not Set" in most situations.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="phpHandlerDef"><h3>PHP Handler Definition<span class="ls-permlink"><a href="#phpHandlerDef"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Add a custom PHP handler by only specifying "Handler ID", "Command", and optional "Handled Suffixes". This method will add an external application and associated script handler automatically.<br/><br/> External applications explicitly defined at the server level with the same "Handler ID" or "Command" will have a higher priority.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> These settings may not be needed as automatically detected PHP handlers should work properly.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="id"><h3>Handler ID<span class="ls-permlink"><a href="#id"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique ID used to associate this PHP handler's command to it's handled suffixes. The ID itself will also be treated as a handled suffix.<br/><br/> Well known IDs include "phpXX", "alt-phpXX", and "ea-phpXX".</p> <h4>Example</h4><div class="ls-example">php72</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> When adding a handler with ID "php72", files with suffix ".php72" as well as MIME type "application/x-httpd-php72" will be automatically handled by this handler.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="phpCommand"><h3>Command<span class="ls-permlink"><a href="#phpCommand"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Command used to start the PHP handler.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This is usually the path to an "lsphp" binary.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="phpSuffixes"><h3>Handled suffixes<span class="ls-permlink"><a href="#phpSuffixes"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Extra file "suffixes" to be handled by this handler.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> If a script handler has been configured explicitly for a provided file suffix, this configuration will be ignored.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="phpDefault"><h3>PHP Handler Defaults<span class="ls-permlink"><a href="#phpDefault"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set the default configuration for handlers defined via <span class="tagl"><a href="#phpHandlerDef">PHP Handler Definition</a></span> .</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="initTimeout"><h3>Initial Request Timeout (secs)<span class="ls-permlink"><a href="#initTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds the server will wait for the external application to respond to the first request over a new established connection. If the server does not receive any data from the external application within this timeout limit, it will mark this connection as bad. This helps to identify communication problems with external applications as quickly as possible. If some requests take longer to process, increase this limit to avoid 503 error messages.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="retryTimeout"><h3>Retry Timeout (secs)<span class="ls-permlink"><a href="#retryTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the period of time that the server waits before retrying an external application that had a prior communication problem.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pcKeepAliveTimeout"><h3>Connection Keepalive Timeout<span class="ls-permlink"><a href="#pcKeepAliveTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds to keep an idle persistent connection open.<br/><br/> When set to "-1", the connection will never timeout. When set to 0 or greater, the connection will be closed after this time in seconds has passed.</p> <h4>Syntax</h4><p>int</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="respBuffer"><h3>Response Buffering<span class="ls-permlink"><a href="#respBuffer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to buffer responses received from external applications. If a "nph-" (Non-Parsed-Header) script is detected, buffering is turned off for responses with full HTTP headers.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="backlog"><h3>Back Log<span class="ls-permlink"><a href="#backlog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the backlog of the listening socket. Required if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="runOnStartUp"><h3>Run On Start Up<span class="ls-permlink"><a href="#runOnStartUp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to start the external application at server start up. Only applicable to external applications that can manage their own child processes and where <span class="tagl"><a href="#instances">Instances</a></span> value is set to "1".<br/><br/> If enabled, external processes will be created at server startup instead of run-time.<br/><br/> When selecting "Yes (Detached mode)", all detached process can be restarted at the Server level or Virtual Host level by touching the '.lsphp_restart.txt' file under the $SERVER_ROOT/admin/tmp/ or $VH_ROOT/ directory respectively.<br/><br/> Default value: Yes (Detached mode)</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If the configured external process has significant startup overhead, like a Rails app, then this option should be enabled to decrease first page response time.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extMaxIdleTime"><h3>Max Idle Time<span class="ls-permlink"><a href="#extMaxIdleTime"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum idle time before an external application is stopped by the server, freeing idle resources. When set to "-1", the external application will not be stopped by the server unless running in ProcessGroup mode where idle external applications will be stopped after 30 seconds.<br/><br/> Default value: <span class="val">-1{/val}</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> This feature is especially useful in the mass hosting environment where, in order to prevent files owned by one virtual host from being accessed by the external application scripts of another virtual host, many different applications are run at the same time in SetUID mode. Set this value low to prevent these external applications from idling unnecessarily.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPriority"><h3>Priority<span class="ls-permlink"><a href="#extAppPriority"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies priority of the external application process. Value ranges from <span class="val">-20</span> to <span class="val">20</span>. A lower number means a higher priority. An external application process cannot have a higher priority than the web server. If this priority is set to a lower number than the server's, the server's priority will be used for this value.</p> <h4>Syntax</h4><p>int</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#serverPriority">Priority</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memSoftLimit"><h3>Memory Soft Limit (bytes)<span class="ls-permlink"><a href="#memSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the memory consumption limit in bytes for an external application process or an external application started by the server.<br/><br/> The main purpose of this limit is to prevent excessive memory usage because of software bugs or intentional attacks, not to impose a limit on normal usage. Make sure to leave enough head room, otherwise your application may fail and 503 error may be returned. It can be set at the server- level or at an individual external application level. The server-level limit will be used if it is not set at the individual application level.<br/><br/> The operating system's default setting will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application needs more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memHardLimit"><h3>Memory Hard Limit (bytes)<span class="ls-permlink"><a href="#memHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#memSoftLimit">Memory Soft Limit (bytes)</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level.<br/><br/> The operating system's default will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application need more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procSoftLimit"><h3>Process Soft Limit<span class="ls-permlink"><a href="#procSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Limits the total number of processes that can be created on behalf of a user. All existing processes will be counted against this limit, not just new processes to be started.<br/><br/> The limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default setting will be used if this value is 0 or absent at both levels.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> To control how many processes LSWS will make for users in mod_suEXEC mode, use the suEXEC Max Conn setting. PHP scripts can call for forking processes and the number of processes needed for normal functioning can be above the suEXEC Max Conn setting. The main purpose of this limit is as a last line of defense to prevent fork bombs and other attacks caused by PHP processes creating other processes.<br/><br/> Setting this setting too low can severely hurt functionality. The setting will thus be ignored below certain levels.<br/><br/> When <b>Run On Start Up</b> is set to "Yes (Daemon mode)", the actual process limit will be higher than this setting to make sure parent processes are not limited.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procHardLimit"><h3>Process Hard Limit<span class="ls-permlink"><a href="#procHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#procSoftLimit">Process Soft Limit</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default value will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
External_FCGI_Auth.html 0000644 00000061033 15055121352 0010767 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Fast CGI Authorizer</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Fast CGI Authorizer." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<li><a href="External_FCGI.html">Fast CGI App</a></li>
<li><span class="current"><a href="External_FCGI_Auth.html">Fast CGI Authorizer</a></span></li>
<li><a href="External_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="External_FCGI.html">Fast CGI App</a></div><div class="center"><a href="ExtApp_Help.html">External Apps</a></div><div class="next"><a href="External_LSAPI.html">LiteSpeed SAPI App</a> »</div></div>
<h1>Fast CGI Authorizer</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Fast CGI Authorizer</header><p>
<a href="#extAppName">Name</a> | <a href="#extAppAddress">Address</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#persistConn">Persistent Connection</a> | <a href="#pcKeepAliveTimeout">Connection Keepalive Timeout</a> | <a href="#respBuffer">Response Buffering</a> | <a href="#autoStart">Start By Server</a> | <a href="#extAppPath">Command</a> | <a href="#backlog">Back Log</a> | <a href="#instances">Instances</a> | <a href="#extUser">Run As User</a> | <a href="#extGroup">Run As Group</a> | <a href="#extUmask">umask</a> | <a href="#runOnStartUp">Run On Start Up</a> | <a href="#extMaxIdleTime">Max Idle Time</a> | <a href="#extAppPriority">Priority</a> | <a href="#memSoftLimit">Memory Soft Limit (bytes)</a> | <a href="#memHardLimit">Memory Hard Limit (bytes)</a> | <a href="#procSoftLimit">Process Soft Limit</a> | <a href="#procHardLimit">Process Hard Limit</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="extAppName"><h3>Name<span class="ls-permlink"><a href="#extAppName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this external application. You will refer to it by this name when you use it in other parts of the configuration.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppAddress"><h3>Address<span class="ls-permlink"><a href="#extAppAddress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique socket address used by the external application. IPv4/IPv6 sockets and Unix Domain Sockets (UDS) are supported. IPv4/IPv6 sockets can be used for communication over the network. UDS can only be used when the external application resides on the same machine as the server.</p> <h4>Syntax</h4><p>IPv4 or IPV6 address:port or UDS://path</p> <h4>Example</h4><div class="ls-example">127.0.0.1:5434<br/> UDS://tmp/lshttpd/php.sock.</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If the external application runs on the same machine, UDS is preferred. If you have to use an IPv4|IPV6 socket, set the IP address to <span class="val">localhost</span> or <span class="val">127.0.0.1</span>, so the external application is inaccessible from other machines.<br/> <span title="Performance" class="ls-icon-performance"></span> Unix Domain Sockets generally provide higher performance than IPv4 sockets.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="initTimeout"><h3>Initial Request Timeout (secs)<span class="ls-permlink"><a href="#initTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds the server will wait for the external application to respond to the first request over a new established connection. If the server does not receive any data from the external application within this timeout limit, it will mark this connection as bad. This helps to identify communication problems with external applications as quickly as possible. If some requests take longer to process, increase this limit to avoid 503 error messages.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="retryTimeout"><h3>Retry Timeout (secs)<span class="ls-permlink"><a href="#retryTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the period of time that the server waits before retrying an external application that had a prior communication problem.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="persistConn"><h3>Persistent Connection<span class="ls-permlink"><a href="#persistConn"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to keep the connection open after a request has been processed. Persistent connections can increase performance, but some FastCGI external applications do not support persistent connections fully. The default is "On".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pcKeepAliveTimeout"><h3>Connection Keepalive Timeout<span class="ls-permlink"><a href="#pcKeepAliveTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds to keep an idle persistent connection open.<br/><br/> When set to "-1", the connection will never timeout. When set to 0 or greater, the connection will be closed after this time in seconds has passed.</p> <h4>Syntax</h4><p>int</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="respBuffer"><h3>Response Buffering<span class="ls-permlink"><a href="#respBuffer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to buffer responses received from external applications. If a "nph-" (Non-Parsed-Header) script is detected, buffering is turned off for responses with full HTTP headers.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoStart"><h3>Start By Server<span class="ls-permlink"><a href="#autoStart"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether you want the web server to start the application automatically. Only FastCGI and LSAPI applications running on the same machine can be started automatically. The IP in the <span class="tagl"><a href="#extAppAddress">Address</a></span> must be a local IP. Starting through the LiteSpeed CGI Daemon instead of a main server process will help reduce system overhead. CGI Daemon Async mode (non-blocking event-driven method) is recommended for servers with high I/O wait.<br/><br/> Default value: Yes (Through CGI Daemon Async)</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPath"><h3>Command<span class="ls-permlink"><a href="#extAppPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the full command line including parameters to execute the external application. Required value if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled. A parameter should be quoted with a double or single quote if the parameter contains space or tab characters.</p> <h4>Syntax</h4><p>Full path to the executable with optional parameters.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#autoStart">Start By Server</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="backlog"><h3>Back Log<span class="ls-permlink"><a href="#backlog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the backlog of the listening socket. Required if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="instances"><h3>Instances<span class="ls-permlink"><a href="#instances"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum instances of the external application the server will create. It is required if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled. Most FastCGI/LSAPI applications can only process one request per process instance and for those types of applications, instances should be set to match the value of <span class="tagl"><a href="#maxConns">Max Connections</a></span>. Some FastCGI/LSAPI applications can spawn multiple child processes to handle multiple requests concurrently. For these types of applications, instances should be set to "1" and environment variables used to control how many child processes the application can spawn.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extUser"><h3>Run As User<span class="ls-permlink"><a href="#extUser"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The external application will run as this specified user name. If not set, Virtual Host level settings will be inherited.<br/><br/> Default value: Not Set</p> <h4>Syntax</h4><p>Valid username.</p> <h4>See Also</h4><p class="ls-text-small">extGroup</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extGroup"><h3>Run As Group<span class="ls-permlink"><a href="#extGroup"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The external application will run as this specified group name. If not set, Virtual Host level settings will be inherited.<br/><br/> Default value: Not Set</p> <h4>Syntax</h4><p>Valid group name.</p> <h4>See Also</h4><p class="ls-text-small">extUser</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extUmask"><h3>umask<span class="ls-permlink"><a href="#extUmask"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Sets default umask for this external application's processes. See <span class="cmd"> man 2 umask </span> for details. The default value taken from the server-level <span class="tagl"><a href="ServSecurity_Help.html#umask">umask</a></span> setting.</p> <h4>Syntax</h4><p>value valid range [000]-[777].</p> <h4>See Also</h4><p class="ls-text-small">CGI <span class="tagl"><a href="ServSecurity_Help.html#umask">umask</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="runOnStartUp"><h3>Run On Start Up<span class="ls-permlink"><a href="#runOnStartUp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to start the external application at server start up. Only applicable to external applications that can manage their own child processes and where <span class="tagl"><a href="#instances">Instances</a></span> value is set to "1".<br/><br/> If enabled, external processes will be created at server startup instead of run-time.<br/><br/> When selecting "Yes (Detached mode)", all detached process can be restarted at the Server level or Virtual Host level by touching the '.lsphp_restart.txt' file under the $SERVER_ROOT/admin/tmp/ or $VH_ROOT/ directory respectively.<br/><br/> Default value: Yes (Detached mode)</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If the configured external process has significant startup overhead, like a Rails app, then this option should be enabled to decrease first page response time.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extMaxIdleTime"><h3>Max Idle Time<span class="ls-permlink"><a href="#extMaxIdleTime"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum idle time before an external application is stopped by the server, freeing idle resources. When set to "-1", the external application will not be stopped by the server unless running in ProcessGroup mode where idle external applications will be stopped after 30 seconds.<br/><br/> Default value: <span class="val">-1{/val}</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> This feature is especially useful in the mass hosting environment where, in order to prevent files owned by one virtual host from being accessed by the external application scripts of another virtual host, many different applications are run at the same time in SetUID mode. Set this value low to prevent these external applications from idling unnecessarily.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPriority"><h3>Priority<span class="ls-permlink"><a href="#extAppPriority"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies priority of the external application process. Value ranges from <span class="val">-20</span> to <span class="val">20</span>. A lower number means a higher priority. An external application process cannot have a higher priority than the web server. If this priority is set to a lower number than the server's, the server's priority will be used for this value.</p> <h4>Syntax</h4><p>int</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#serverPriority">Priority</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memSoftLimit"><h3>Memory Soft Limit (bytes)<span class="ls-permlink"><a href="#memSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the memory consumption limit in bytes for an external application process or an external application started by the server.<br/><br/> The main purpose of this limit is to prevent excessive memory usage because of software bugs or intentional attacks, not to impose a limit on normal usage. Make sure to leave enough head room, otherwise your application may fail and 503 error may be returned. It can be set at the server- level or at an individual external application level. The server-level limit will be used if it is not set at the individual application level.<br/><br/> The operating system's default setting will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application needs more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="memHardLimit"><h3>Memory Hard Limit (bytes)<span class="ls-permlink"><a href="#memHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#memSoftLimit">Memory Soft Limit (bytes)</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level.<br/><br/> The operating system's default will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application need more memory.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procSoftLimit"><h3>Process Soft Limit<span class="ls-permlink"><a href="#procSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Limits the total number of processes that can be created on behalf of a user. All existing processes will be counted against this limit, not just new processes to be started.<br/><br/> The limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default setting will be used if this value is 0 or absent at both levels.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> To control how many processes LSWS will make for users in mod_suEXEC mode, use the suEXEC Max Conn setting. PHP scripts can call for forking processes and the number of processes needed for normal functioning can be above the suEXEC Max Conn setting. The main purpose of this limit is as a last line of defense to prevent fork bombs and other attacks caused by PHP processes creating other processes.<br/><br/> Setting this setting too low can severely hurt functionality. The setting will thus be ignored below certain levels.<br/><br/> When <b>Run On Start Up</b> is set to "Yes (Daemon mode)", the actual process limit will be higher than this setting to make sure parent processes are not limited.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="procHardLimit"><h3>Process Hard Limit<span class="ls-permlink"><a href="#procHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#procSoftLimit">Process Soft Limit</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default value will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
LSAPI_Context.html 0000644 00000063076 15055121352 0010021 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - LiteSpeed SAPI Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - LiteSpeed SAPI Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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><span class="current"><a href="LSAPI_Context.html">LSAPI Context</a></span></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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="FCGI_Context.html">Fast CGI Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="Proxy_Context.html">Proxy Context</a> »</div></div>
<h1>LiteSpeed SAPI Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#lsapiContext">LiteSpeed SAPI Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#lsapiapp">LiteSpeed SAPI App</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="lsapiContext"><h3>LiteSpeed SAPI Context<span class="ls-permlink"><a href="#lsapiContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>External applications cannot be used directly. They must be either configured as a script handler or mapped to a URL through a context. An LiteSpeed SAPI Context will associate a URI with an LSAPI (LiteSpeed Server Application Programming Interface) application. Currently PHP, Ruby and Python have LSAPI modules. LSAPI, as it is developed specifically for LiteSpeed web server, is the most efficient way to communicate with LiteSpeed web server.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="lsapiapp"><h3>LiteSpeed SAPI App<span class="ls-permlink"><a href="#lsapiapp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the LiteSpeed SAPI application to be connected to this context. This application must be defined in the <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> section at the server or virtual host level.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Cache_Help.html 0000644 00000045136 15055121352 0007415 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Page Cache Settings</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Page Cache Settings." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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><span class="current"><a href="Cache_Help.html">Page Cache</a></span></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="ServSecurity_Help.html">Server Security</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="PageSpeed_Config.html">PageSpeed Config</a> »</div></div>
<h1>Page Cache Settings</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Cache Storage Settings</header><p>
<a href="#cacheEngine">Cache Features</a> | <a href="#cacheStorePath">Storage Path</a> | <a href="#litemage">Enable LiteMage</a> | <a href="#cacheMgrStorePath">Cache Manager Path</a> | <a href="#pubStoreExpireMinutes">Public Storage Expire (minutes)</a> | <a href="#purgeNoHitTimeout">No Hit Expire (minutes)</a></p></section>
<section class="toc-row"><header>Cache Policy</header><p>
<a href="#checkPublicCache">Check Public Cache</a> | <a href="#checkPrivateCache">Check Private Cache</a> | <a href="#respectCacheable">Respect Cacheable</a> | <a href="#cachePolicy:maxCacheObjSize">Max Object Size</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:cacheKeyMod">Cache Key Modifications</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a></p></section>
<section class="toc-row"><header>Do-Not-Cache URL</header><p>
<a href="#noCacheUrl">Do-Not-Cache URL</a></p></section>
<section class="toc-row"><header>Do-Not-Cache Domains</header><p>
<a href="#noCacheDomain">No Cache Domain</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="cacheEngine"><h3>Cache Features<span class="ls-permlink"><a href="#cacheEngine"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a selection of cache features to individually enable.<br/><br/> <span class="val">On</span>: Enable the cache engine.<br/> <span class="val">Crawler</span>: Enable crawler feature.<br/> <span class="val">ESI</span>: Enable ESI feature.<br/><br/> Features enabled globally at the Server level can be overridden at the Virtual Host level.<br/><br/> Note: Setting <span class="tagl"><a href="#litemage">Enable LiteMage</a></span> to <span class="val">On</span> at the Virtual Host level will override this setting and automatically enable the cache engine and all features.<br/><br/> Default value: Everything enabled</p> <h4>Syntax</h4><p>Select from checkbox</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cacheStorePath"><h3>Storage Path<span class="ls-permlink"><a href="#cacheStorePath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the directory for holding cached objects. Currently, LiteSpeed Cache stores each object in its own file. The filename is a hash of the object key. Multiple levels of directories will be created in order to avoid holding too many files in one directory. This value must be set at the Server level in order to enable cache. Virtual Host level settings will override Server level settings.</p> <h4>Syntax</h4><p>path</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Assign a dedicated disk or disk array as the cache storage. RAID0 is recommended.<br/><br/> It is recommended to set a different cache storage path for each Virtual Host to prevent purge all requests from affecting other Virtual Hosts.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="litemage"><h3>Enable LiteMage<span class="ls-permlink"><a href="#litemage"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables LiteMage Cache for Magento Stores.<br/><br/> When set to 'On' the server will also try to use shared private cache information to speed up page load time for first time visitors. Select 'Safe' to disable this feature.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting will not work if your LiteSpeed license does not have the LiteMage module enabled.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cacheMgrStorePath"><h3>Cache Manager Path<span class="ls-permlink"><a href="#cacheMgrStorePath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the directory used to store cache manager files. These files are stored in <b>Storage Path</b> by default.</p> <h4>Syntax</h4><p>path</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> A separate location on a fast disk is recommended to prevent the accidental removal of cache manager files. Only set to a location on a RAM disk if cache storage is also saved on a RAM disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pubStoreExpireMinutes"><h3>Public Storage Expire (minutes)<span class="ls-permlink"><a href="#pubStoreExpireMinutes"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The maximum age of a cached file before the server will attempt to physically remove it. This removal operation will occur once per day to prevent cache storage from growing too large. Minimum setting is 60 minutes.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Set this value to a time greater than your longest TTL to help prevent the removal of still valid cache files.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="purgeNoHitTimeout"><h3>No Hit Expire (minutes)<span class="ls-permlink"><a href="#purgeNoHitTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The maximum number of minutes a cached file will remain in cache storage without a cache hit before being physically removed by the server. Set to 0 to disable this feature.<br/><br/> Default value: 0</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="checkPublicCache"><h3>Check Public Cache<span class="ls-permlink"><a href="#checkPublicCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to check against the public cache for URLs requested in the current context. Can be set at the server level, virtual host level, or context level.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="checkPrivateCache"><h3>Check Private Cache<span class="ls-permlink"><a href="#checkPrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to check against the private cache for URLs requested in the current context. Can be set at the server, virtual host, or context level.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="respectCacheable"><h3>Respect Cacheable<span class="ls-permlink"><a href="#respectCacheable"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Respect the value of regular "Cache-Control" response headers when LiteSpeed-specific cache control has not been provided.<br/><br/> LiteSpeed-specific cache control includes the X-litespeed-cache-control response header and the cache-control environment variable set via rewrite rule.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting is enabled by default.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxCacheObjSize"><h3>Max Object Size<span class="ls-permlink"><a href="#cachePolicy:maxCacheObjSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum size of an object, up to 100M, that can be stored in the cache directory.<br/><br/> Default value: 10M</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:cacheKeyMod"><h3>Cache Key Modifications<span class="ls-permlink"><a href="#cachePolicy:cacheKeyMod"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Makes some requests more cache-friendly by allowing junk query string parameters to be dropped from URLs.</p> <h4>Syntax</h4><p><span class="val">clear</span> discards all previous configurations, <span class="val">-qs:[string]</span> drop all query strings where the name matches [string] exactly, or <span class="val">-qs:utm*</span> drop all query strings where the name part starts with [string]. Input one rule per line.</p> <h4>Example</h4><div class="ls-example"><span class="val">-qs:utm*</span> drops all query strings where the name part starts with "utm".<br/> <span class="val">-qs:gclid</span> drops all query strings where the name matches "gclid" exactly.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="noCacheUrl"><h3>Do-Not-Cache URL<span class="ls-permlink"><a href="#noCacheUrl"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A list of URL segments where any URL containing these listed segments will not be cached. String matching is used. Regular expressions are not supported. Can be set at the server or virtual host level. URL segments listed at the server level are inherited by all virtual hosts and added to their <b>Do-Not-Cache URL</b> lists.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> You can add comments by starting a line with "#".</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="noCacheDomain"><h3>No Cache Domain<span class="ls-permlink"><a href="#noCacheDomain"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A comma-separated list of domains that will not be cached.</p> <h4>Syntax</h4><p>Comma-separated list. Domain names are case insensitive and the leading "www." should be removed. The wildcard characters "*" and "?" are allowed. "?" only replaces one character. "*" replaces any number of characters. For example, "*.mydomain.com" will match all subdomains of mydomain.com. Duplicate domain names are not allowed.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
install.html 0000644 00000046563 15055121352 0007115 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Installation</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Installation." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><span class="current"><a href="install.html">Installation</a></span></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="intro.html">Introduction</a></div><div class="center"><a href="index.html">Home</a></div><div class="next"><a href="admin.html">Administration</a> »</div></div>
<h1>Installation/Uninstallation</h1>
<h2>Minimum system requirements</h2>
<ul>
<li>
<strong>Operating System:</strong>
<ul>
<li>Linux: kernel 2.4 and up, glibc-2.2 and up</li>
<li>CentOS: 5 and up</li>
<li>Ubuntu: 8.04 and up</li>
<li>Debian: 4 and up</li>
<li>AlmaLinux: 8 and up</li>
<li>Solaris: Sun0S 5.8 and up</li>
<li>FreeBSD: 4.5 and up</li>
<li>MacOSX: 10.3 and up</li>
</ul>
</li>
<li>
<strong>CPU:</strong>
<ul>
<li>Intel: 80486 and up</li>
<li>PowerPC: PowerPC G4</li>
</ul>
</li>
<li><strong>Memory:</strong> 32MB and up</li>
<li>
<strong>Disk:</strong>
<ul>
<li>Installation: 200MB</li>
<li>Runtime: 300MB and up, swapping space depends on usage.</li>
</ul>
</li>
</ul>
<h2>Installation</h2>
<p>
Installation must be performed in a command line terminal. For testing
purposes, LiteSpeed Web Server can be installed into a home directory by a
non-privileged user. For production use, it should be installed into a system
directory.
</p>
<p>
In Mac OS X, root user is disabled by default. It can be enabled using a
series of actions detailed on the
<a href="https://support.apple.com/en-us/HT204012">Apple</a> website. You can
also use the sudo command to install LSWS into a system directory without
enabling the root user, but system folders will still only be manipulable by
the root user. This means that every time you want to control LSWS from the
command line terminal (like when you want to start or stop LSWS), you will
have to use the sudo command.
</p>
<h3>Installation Steps:</h3>
<ol>
<li> Decompress the package into a convenient location:<br>
<span class="cmd">tar xvfz lsws-xxxx.tar.gz</span> or
<span class="cmd">gunzip -c lsws-xxxx.tar.gz | tar xvf -</span>
<br />
</li>
<li>
<span class="tag">[Enterprise Edition Only]</span> Install trial license
key or serial number:
<ul>
<li>
Trial License:
<p>
A trial license is for evaluation purposes and is only good for 15
days after download. A trial license can be requested from download
page.
</p>
<p>
A trial license key will be sent to you as an attachment in a
confirmation email. Please save the attachment as
<span class="val">trial.key</span> and copy it to the installation
directory.
</p>
<p>
When you switch from a trial license to a production license, you can
simply run the install script again after following the steps below
to update your license.
</p>
</li>
<li>
Production license:
<ol>
<li>
Licenses can be leased or purchased at the LiteSpeed
<a href="https://store.litespeedtech.com/store/cart.php">store</a>.
</li>
<li>
A serial number will be sent to you in the confirmation email after
you order has been successfully processed. Each serial number
allows for one server installation.
</li>
<li>
Save the serial number as "serial.no"; in the installation
directory (where install.sh is located). The LiteSpeed products
registration server will use this file to retrieve your license key
during the installation process.
</li>
</ol>
</li>
</ul>
</li>
<li>
<p>
Go to the installation directory <span class="cmd">cd lsws-xxxx</span>
and run command <span class="cmd">./install.sh</span> This will start
LiteSpeed's Installer.
</p>
<p>
Note that only by running this command as the "root" user can
you install the server into a system directory. Other users should
install it to somewhere under their home directory.
</p>
<p>
Mac OS X users can install the server into a system directory with
command <span class="cmd">sudo ./install.sh</span>
</p>
</li>
<li>
Read the End User License Agreement and type "Yes" to confirm your
agreement.
</li>
<li>
Specify the directory where you would like to install LiteSpeed Web Server.
For the root user, the default is /usr/local/lsws. For non-privileged users,
the default is their home directory. Remember, non-privileged users will
not be able to install the server into a system directory.
</li>
<li>
<span class="tag">[Enterprise Edition Only]</span>
<strong>Generate license request.</strong>
<p>
If the Installer only finds serial number but no valid license key, it
will prompt to generate a license request. The installer will talk to
LiteSpeed products registration server and obtain a valid license key
automatically. Upon getting the license key, it will go to next step. If
failed, the installer will exit and leave a license request file.
</p>
<p>
If the automatic process failed, you can create a ticket with license
department from online store client area.
</p>
<p>
Note: Installation will continue only if there is a valid trial license
or valid Enterprise license.
</p>
</li>
<li>
Follow the instructions on the screen. The Installer will ask you to set
the following:
<ol>
<li>
If a previously installed copy exists, the Installer will ask you to
choose either upgrade, reinstall, or change directory. Upgrading will
keep your current configurations.
</li>
<li>
Administrator's username and password for the WebAdmin interface.
</li>
<li>What control panel, if any, you will use with LSWS.</li>
<li>User and group that the server process will run on behalf of.</li>
<li>TCP port for normal web service.</li>
<li>TCP port for WebAdmin interface. </li>
<li>Whether to set up LiteSpeed PHP.</li>
<li>
<span class="tag">[Enterprise Edition Only]</span> Root user has the
option to enable chroot. The installer will setup the initial chroot
environment automatically. Chroot is an advanced feature and your CGI
may fail without configuration tuning. We strongly recommend not
enabling chroot unless you are familiar with it. You can always enable
it later by performing an upgrade installation.
</li>
</ol>
<p>
Finally, the Installer will ask you if you want to install the AWStats
add-on module to keep track of your web statistics. Root user can also
choose to run LiteSpeed Web Server automatically at system startup as a
service. Then you're done! The installer can start up the server.
</p>
</li>
</ol>
<h3>Testing Installation</h3>
<ol>
<li>
For detailed information on controlling the server processes, please see
the <a href="admin.html">Administration Guide</a>. To start the server,
simply run <span class="cmd">[your_install_dir]/bin/lswsctrl start</span>.
</li>
<li>
To access your site, point your browser to
<span class="val">http://[address]:8088/</span>, [address] being the IP
address or domain name of your web server machine. Use "localhost" if the
server is on the machine you are using. "8088" is the default port. If you
changed the port during installation, write the port you designated. A
congratulations page should load into the browser. If not, try the WebAdmin
interface.
</li>
<li>
The default port for the WebAdmin interface is 7080. Plug
<span class="val">http://[address]:7080/</span>, into your browser to go to
the WebAdmin interface. (If you changed the port for WebAdmin during
installation, use that port instead.) Remember that for [address] you can
use "localhost" if you're using the machine the server is on. The
administration interface welcome page should load. Click the "Log on" link
and use the administrator's username and password specified during
installation to log on. For detailed information regarding configuration,
please refer to our <a href="config.html">Configuration Guide</a>, or click
the "help" link on top of each page.
</li>
<li>
If your server uses firewall, please make sure that localhost is trusted.
For instance, Linux with IPTables should include a rule
<span class="cmd">ALLOW INPUT from LO</span>.
<br />
</li>
<li>
If your web site and the WebAdmin interface are inaccessible, please take a
look at the error log -
<span class="cmd">[your_install_dir]/logs/error.log</span>
<ul>
<li>
If there is a TCP port conflict with other server applications, the web
server should be reinstalled with an available port.
<br />
The following command can be used to find an available port:
<br />
<span class="cmd">netstat -an | grep XXXX</span>
<br />
XXXX is a port number. If the port is available, the command will
produce no output.
</li>
<li>
If the swapping directory is not writable, you can either grant writing
permission for the swapping directory to the user whom the web server
is running as, or change the swapping directory manually. The swapping
directory is configured in the server's XML configuration file located
at <span class="cmd">[your_install_dir]/conf/httpd_config.xml</span>,
default value is <span class="cmd">/tmp/lshttpd/swap</span>. Search for
<span class="cmd"><swappingDir></span>.
</li>
</ul>
</li>
</ol>
<p>
If you still have problems with installation, please check out our
<a href="https://www.litespeedtech.com/support/wiki/doku.php">wiki</a> or
post your problem on our support
<a href="https://www.litespeedtech.com/support/forum/">forum</a>.
</p>
<h2>Upgrading</h2>
<p>
There are a few scenarios where you would need to update or upgrade the
server:
</p>
<ul>
<li>A new release is available</li>
<li>Upgrade from a trial license to production license</li>
<li>Upgrade/downgrade to a different production license.</li>
</ul>
<p>
There are a number of ways to upgrade. One way is to just run install.sh
again and select "Upgrade" when prompted. Your current
configurations will be kept.
</p>
<p>
Starting with release 2.0, version management can also be done from the
WebAdmin Console interface, under Actions - Version Management. All your
installed versions and the available new releases are listed here. You can
install a new release or switch between different versions by clicking the
appropriate link. Since release 2.0, LSWS also features a built-in update
agent that will check for new releases periodically and send email
notifications.
</p>
<p>
Starting with release 4.1, you can upgrade to the latest release, force
reinstall, or downgrade to an old version using the command line tool
lsup.sh. See detailed usage information in
<span class="cmd">[your_install_dir]/admin/misc/lsup.sh --help</span>
</p>
<p>
Since release 1.5.6, multiple versions of LiteSpeed Web Server can be
installed. You can easily switch from one to another by using the version
management utility:
<span class="cmd">[your_install_dir]/admin/misc/mgr_ver.sh</span>.
</p>
<ul>
<li>
To switch to a version already installed, for example 1.5.6, just run
<span class="cmd">
[your_install_dir_current_version]/admin/misc/mgr_ver.sh 1.5.6
</span>
</li>
<li>
To remove previously installed files for a certain version, for example
1.5.6, just run
<span class="cmd">
[your_install_dir_current_version]/admin/misc/mgr_ver.sh -d 1.5.6
</span>
</li>
</ul>
<p>
When upgrading your license (from trial to production license, for example),
you can manually copy "serial.no" to the
<span class="cmd">[your_install_dir]/conf/</span> directory, then restart.
Please backup your old serial number and license key before restart.
</p>
<h2>License transfer procedure:</h2>
<p>
Please be aware that each license key is associated with a serial number and
the server's hardware signature. A new key is required if a change in
hardware signature is detected. So if you upgrade or change your hardware,
you need to transfer your current production license in order to continue
using the product.
</p>
<ol>
<li>
To migrate your current license, you can simply run the server binary
<span class="cmd">./lshttpd -m</span>. It will talk to LiteSpeed' products
registration server, unlock your serial number, and generate a temporary
license key. This temporary key is good for 3 days. This allows you a
smooth transition to the new server.
</li>
<li>
If you wish, you can take this chance to download the latest version of
LiteSpeed Web Server to your new hardware. Then copy the serial number file
"serial.no" to the installation directory and start up the Installer. You
unlocked your serial number in the previous step, so running the Installer
will get you a new license key.
</li>
<li>
If you wish to copy your old installation directory over to the new
hardware, then you just need to activate your license. Run command
<span class="cmd">./lshttpd -r</span> to retrieve a new license key.
</li>
<li>
If the process fails, you can create a ticket with the license department
in the <a href="https://store.litespeedtech.com">client area</a> of the
online store.
</li>
</ol>
<h2>Uninstallation Steps</h2>
<ol>
<li>
Simply run
<span class="cmd">[your_install_dir]/admin/misc/uninstall.sh</span> and
follow the instructions on the screen.
</li>
<li>
The Uninstaller will ask the following questions:
<ul>
<li>whether to keep the log directory</li>
<li>whether to keep the configuration directory</li>
</ul>
<br />
</li>
<li>
Directories that were not created by the Installer will not be touched,
even if they are in [your_install_dir]. All the files created by the
installer will be removed.
</li>
<li>[your_install_dir] will be removed as well, if it is empty.</li>
</ol></article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
External_PL.html 0000644 00000032043 15055121352 0007610 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Piped Logger</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Piped Logger." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><span class="current"><a href="External_PL.html">Piped logger</a></span></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="External_WS.html">Web Server</a></div><div class="center"><a href="ExtApp_Help.html">External Apps</a></div><div class="next"><a href="External_LB.html">Load Balancer</a> »</div></div>
<h1>Piped Logger</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Piped Logger</header><p>
<a href="#extAppName">Name</a> | <a href="#extAppAddress">Address</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#extAppPath">Command</a> | <a href="#instances">Instances</a> | <a href="#extUser">Run As User</a> | <a href="#extGroup">Run As Group</a> | <a href="#extUmask">umask</a> | <a href="#extAppPriority">Priority</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="extAppName"><h3>Name<span class="ls-permlink"><a href="#extAppName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this external application. You will refer to it by this name when you use it in other parts of the configuration.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppAddress"><h3>Address<span class="ls-permlink"><a href="#extAppAddress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique socket address used by the external application. IPv4/IPv6 sockets and Unix Domain Sockets (UDS) are supported. IPv4/IPv6 sockets can be used for communication over the network. UDS can only be used when the external application resides on the same machine as the server.</p> <h4>Syntax</h4><p>IPv4 or IPV6 address:port or UDS://path</p> <h4>Example</h4><div class="ls-example">127.0.0.1:5434<br/> UDS://tmp/lshttpd/php.sock.</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If the external application runs on the same machine, UDS is preferred. If you have to use an IPv4|IPV6 socket, set the IP address to <span class="val">localhost</span> or <span class="val">127.0.0.1</span>, so the external application is inaccessible from other machines.<br/> <span title="Performance" class="ls-icon-performance"></span> Unix Domain Sockets generally provide higher performance than IPv4 sockets.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPath"><h3>Command<span class="ls-permlink"><a href="#extAppPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the full command line including parameters to execute the external application. Required value if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled. A parameter should be quoted with a double or single quote if the parameter contains space or tab characters.</p> <h4>Syntax</h4><p>Full path to the executable with optional parameters.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#autoStart">Start By Server</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="instances"><h3>Instances<span class="ls-permlink"><a href="#instances"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum instances of the external application the server will create. It is required if <span class="tagl"><a href="#autoStart">Start By Server</a></span> is enabled. Most FastCGI/LSAPI applications can only process one request per process instance and for those types of applications, instances should be set to match the value of <span class="tagl"><a href="#maxConns">Max Connections</a></span>. Some FastCGI/LSAPI applications can spawn multiple child processes to handle multiple requests concurrently. For these types of applications, instances should be set to "1" and environment variables used to control how many child processes the application can spawn.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extUser"><h3>Run As User<span class="ls-permlink"><a href="#extUser"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The external application will run as this specified user name. If not set, Virtual Host level settings will be inherited.<br/><br/> Default value: Not Set</p> <h4>Syntax</h4><p>Valid username.</p> <h4>See Also</h4><p class="ls-text-small">extGroup</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extGroup"><h3>Run As Group<span class="ls-permlink"><a href="#extGroup"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The external application will run as this specified group name. If not set, Virtual Host level settings will be inherited.<br/><br/> Default value: Not Set</p> <h4>Syntax</h4><p>Valid group name.</p> <h4>See Also</h4><p class="ls-text-small">extUser</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extUmask"><h3>umask<span class="ls-permlink"><a href="#extUmask"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Sets default umask for this external application's processes. See <span class="cmd"> man 2 umask </span> for details. The default value taken from the server-level <span class="tagl"><a href="ServSecurity_Help.html#umask">umask</a></span> setting.</p> <h4>Syntax</h4><p>value valid range [000]-[777].</p> <h4>See Also</h4><p class="ls-text-small">CGI <span class="tagl"><a href="ServSecurity_Help.html#umask">umask</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPriority"><h3>Priority<span class="ls-permlink"><a href="#extAppPriority"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies priority of the external application process. Value ranges from <span class="val">-20</span> to <span class="val">20</span>. A lower number means a higher priority. An external application process cannot have a higher priority than the web server. If this priority is set to a lower number than the server's, the server's priority will be used for this value.</p> <h4>Syntax</h4><p>int</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#serverPriority">Priority</a></span></p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
App_Server_Context.html 0000644 00000121105 15055121352 0011203 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - App Server Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - App Server Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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><span class="current"><a href="App_Server_Context.html">App Server Context</a></span></li>
<li><a href="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Redirect_Context.html">Redirect Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="Rails_Context.html">Rack/Rails Context</a> »</div></div>
<h1>App Server Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#appServerContext">App Server Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#as_location">Location</a> | <a href="#binPath">Binary Path</a> | <a href="#appType">Application Type</a> | <a href="#as_startupfile">Startup File</a> | <a href="#appserverEnv">Run-Time Mode</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#enableExpires">Enable Expires</a> | <a href="#expiresDefault">Expires Default</a> | <a href="#expiresByType">Expires By Type</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#indexFiles">Index Files</a> | <a href="#autoIndex">Auto Index</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#enableRewrite">Enable Rewrite</a> | <a href="#rewriteInherit">Rewrite Inherit</a> | <a href="#rewriteBase">Rewrite Base</a> | <a href="#rewriteRules">Rewrite Rules</a> | <a href="#checkPublicCache">Check Public Cache</a> | <a href="#checkPrivateCache">Check Private Cache</a> | <a href="#respectCacheable">Respect Cacheable</a> | <a href="#cachePolicy:maxCacheObjSize">Max Object Size</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:cacheKeyMod">Cache Key Modifications</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="appServerContext"><h3>App Server Context<span class="ls-permlink"><a href="#appServerContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>An App Server Context provides an easy way to configure a Ruby Rack/Rails, WSGI, or Node.js application. To add a an application through an App Server Context, only mounting the URL and the application's root directory is required. There is no need to go through all the trouble to define an external application, add a 404 handler, and rewrite rules, etc.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="as_location"><h3>Location<span class="ls-permlink"><a href="#as_location"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the corresponding location of this context in the file system.<br/><br/> Default value: $DOC_ROOT + <span class="tagl"><a href="#expuri">URI</a></span></p> <h4>Syntax</h4><p>It can be an absolute path or path relative to $SERVER_ROOT, $VH_ROOT, or $DOC_ROOT. $DOC_ROOT is the default relative path, and can be omitted.<br/><br/> If the <span class="tagl"><a href="#expuri">URI</a></span> is a regular expression, then the matched sub-string can be used to form the "Root" string. The matched sub-string can be referenced with the values "$1" - "$9". "$0" and "&" can be used to reference the whole matched string. Additionally, a query string can be set by appending a "?" followed by the query string. Be careful. "&" should be escaped as "\&" in the query string.</p> <h4>Example</h4><div class="ls-example">A plain URI like <span class="val">/examples/</span> with <span class="tagl"><a href="#location">Location</a></span> set to <span class="val">/home/john/web_examples</span> will map the request "/examples/foo/bar.html" to file "/home/john/web_examples/foo/bar.html".<br/> To simulate Apache's mod_userdir, set URI to <span class="val">exp: ^/~([A-Za-z0-9]+)(.*)</span>, set <span class="tagl"><a href="#location">Location</a></span> to <span class="val">/home/$1/public_html$2</span>. With these settings, a request of URI /~john/foo/bar.html will map to file /home/john/public_html/foo/bar.html.</div><h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#expuri">URI</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="binPath"><h3>Binary Path<span class="ls-permlink"><a href="#binPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The location of the App Server application binary.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="appType"><h3>Application Type<span class="ls-permlink"><a href="#appType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The type of application used for this context. Rack/Rails, WSGI, or Node.js are supported.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="as_startupfile"><h3>Startup File<span class="ls-permlink"><a href="#as_startupfile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The location of file used to start the application, relative to the application root directory.<br/><br/> Default startup file names include 'config.ru' for Rack/Rails, 'wsgi.py' and 'passenger_wsgi.py' for WSGI, and 'app.js' for NodeJS.</p> <h4>Syntax</h4><p>Path relative to application root directory</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="appserverEnv"><h3>Run-Time Mode<span class="ls-permlink"><a href="#appserverEnv"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which mode the application will be running as: "Development", "Production", or "Staging". The default is "Production".</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableExpires"><h3>Enable Expires<span class="ls-permlink"><a href="#enableExpires"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresDefault"><h3>Expires Default<span class="ls-permlink"><a href="#expiresDefault"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresByType"><h3>Expires By Type<span class="ls-permlink"><a href="#expiresByType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="indexFiles"><h3>Index Files<span class="ls-permlink"><a href="#indexFiles"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Only set index files that you need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoIndex"><h3>Auto Index<span class="ls-permlink"><a href="#autoIndex"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Security" class="ls-icon-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"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableRewrite"><h3>Enable Rewrite<span class="ls-permlink"><a href="#enableRewrite"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable LiteSpeed's URL rewrite engine. This option can be customized at the virtual host or context level, and is inherited along the directory tree until it is explicitly overridden.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteInherit"><h3>Rewrite Inherit<span class="ls-permlink"><a href="#rewriteInherit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to inherit rewrite rules from parent contexts. If rewrite is enabled and not inherited, rewrite base and rewrite rules defined in this context will be used.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteBase"><h3>Rewrite Base<span class="ls-permlink"><a href="#rewriteBase"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the base URL for rewrite rules.</p> <h4>Syntax</h4><p>URL</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteRules"><h3>Rewrite Rules<span class="ls-permlink"><a href="#rewriteRules"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a list of rewrite rules at the virtual host level.<br/><br/> Do NOT add any document root level rewrite rules here. If you have any document root level rewrite rules from .htaccess, you should instead create a static context with uri "/" and add the rewrite rules there.<br/><br/> A rewrite rule is comprised of one <span class="val">RewriteRule</span> directive and optionally preceded by multiple <span class="val">RewriteCond</span> directives. <ul> <li>Each directive should take only one line.</li> <li> <span class="val">RewriteCond</span> and <span class="val">RewriteRule</span> follow Apache's rewrite directive syntax. Just copy and paste rewrite directives from your Apache configuration files. </li> <li> There are minor differences between LiteSpeed and Apache mod_rewrite implementation: <ul> <li> <span class="val">%\{LA-U:variable\}</span> and <span class="val">%\{LA-F:variable\}</span> are ignored by the LiteSpeed rewrite engine </li> <li> Two new server variables are added in the LiteSpeed rewrite engine: <span class="val">%\{CURRENT_URI\}</span> represents the current URI being processed by the rewrite engine and <span class="val">%\{SCRIPT_NAME\}</span> has the same meaning as the corresponding CGI environment variable. </li> <li> The LiteSpeed rewrite engine will stop processing rewrite rules after encountering an <span class="val">[L]</span> flag to avoid looping while Apache mod_rewrite will stop processing rewrite rules for the current iteration only. This behavior is similar to that of the <span class="val">[END]</span> flag in Apache mod_rewrite. </li> </ul> </li> </ul><br/> The implementation of LiteSpeed's rewrite engine follows Apache's rewrite engine specifications. For more details about rewrite rules, please refer to <a href="https://httpd.apache.org/docs/current/mod/mod_rewrite.html" target="_blank" rel="noopener noreferrer"> Apache's mod_rewrite document </a> and <a href="https://httpd.apache.org/docs/current/rewrite/" target="_blank" rel="noopener noreferrer"> Apache's URL rewriting guide </a>.</p> <h4>Syntax</h4><p>string</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="checkPublicCache"><h3>Check Public Cache<span class="ls-permlink"><a href="#checkPublicCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to check against the public cache for URLs requested in the current context. Can be set at the server level, virtual host level, or context level.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="checkPrivateCache"><h3>Check Private Cache<span class="ls-permlink"><a href="#checkPrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to check against the private cache for URLs requested in the current context. Can be set at the server, virtual host, or context level.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="respectCacheable"><h3>Respect Cacheable<span class="ls-permlink"><a href="#respectCacheable"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Respect the value of regular "Cache-Control" response headers when LiteSpeed-specific cache control has not been provided.<br/><br/> LiteSpeed-specific cache control includes the X-litespeed-cache-control response header and the cache-control environment variable set via rewrite rule.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting is enabled by default.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxCacheObjSize"><h3>Max Object Size<span class="ls-permlink"><a href="#cachePolicy:maxCacheObjSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum size of an object, up to 100M, that can be stored in the cache directory.<br/><br/> Default value: 10M</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:cacheKeyMod"><h3>Cache Key Modifications<span class="ls-permlink"><a href="#cachePolicy:cacheKeyMod"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Makes some requests more cache-friendly by allowing junk query string parameters to be dropped from URLs.</p> <h4>Syntax</h4><p><span class="val">clear</span> discards all previous configurations, <span class="val">-qs:[string]</span> drop all query strings where the name matches [string] exactly, or <span class="val">-qs:utm*</span> drop all query strings where the name part starts with [string]. Input one rule per line.</p> <h4>Example</h4><div class="ls-example"><span class="val">-qs:utm*</span> drops all query strings where the name part starts with "utm".<br/> <span class="val">-qs:gclid</span> drops all query strings where the name matches "gclid" exactly.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
index.html 0000644 00000014011 15055121352 0006535 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Home</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Home." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><span class="current"><a href="index.html">Users' Manual</a></span></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><section class="ls-index">
<header>
<h1>
LiteSpeed Web Server 6.3
<br /><br />
Users' Manual
<br /><br />
— Rev. 4
</h1>
</header>
<hr />
<header><h2>Table of Contents</h2></header>
<ol>
<li><span><a href="license.html">License Enterprise</a></span></li>
<li><span><a href="intro.html">Introduction</a></span></li>
<li>
<span><a href="install.html">Installation/Uninstallation</a></span>
</li>
<li>
<span>
<a href="admin.html">
Administration
</a>/<a href="ServerStat_Help.html">Service Manager</a>
</span>
</li>
<li><span><a href="security.html">Security</a></span></li>
<li><span><a href="config.html">Configurations</a></span></li>
</ol>
<p>
For more information, visit our
<a href="https://docs.litespeedtech.com/">
Documentation Site
</a>
</p>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
webconsole.html 0000644 00000013215 15055121352 0007573 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Web Console</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Web Console." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</a></li>
</ul>
</li>
<li>
<span class="current"><a href="webconsole.html">Web Console</a></span>
<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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="config.html">Configuration</a></div><div class="center"><a href="index.html">Home</a></div><div class="next"> </div></div>
<h1>Web Console</h1>
<p>The Web Console section controls the settings for the WebAdmin Console. Some of these settings include:</p>
<ul>
<li>Session Timeout</li>
<li>Log Settings</li>
<li>Access Control</li>
<li>Create/Delete Admin Users</li>
<li>Reset Admin Passwords</li>
<li>WebAdmin Listeners & SSL Settings</li>
</ul></article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
VHSecurity_Help.html 0000644 00000130213 15055121352 0010446 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Virtual Host Security</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Virtual Host Security." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</a></li>
<li><a href="VHGeneral_Help.html">Virtual Host General</a></li>
<li><span class="current"><a href="VHSecurity_Help.html">Virtual Host Security</a></span></li>
<li><a href="VHSSL_Help.html">Virtual Host SSL</a></li>
<li>
<a href="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="VHGeneral_Help.html">Virtual Host General</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="VHSSL_Help.html">Virtual Host SSL</a> »</div></div>
<h1>Virtual Host Security</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>WordPress Brute Force Attack Protection</header><p>
<a href="#wpProtectAction">Protection Mode</a> | <a href="#wpProtectLimit">Allowed Login Attempts</a></p></section>
<section class="toc-row"><header>Web Application Firewall (WAF)</header><p>
<a href="#enableCensorship">Enable WAF</a> | <a href="#censorLogLevel">Log Level</a> | <a href="#defaultAction">Default Action</a> | <a href="#scanPOST">Scan Request Body</a></p></section>
<section class="toc-row"><header><a href="#reqCensorshipRule">Web Application Firewall (WAF) Rule Set</a></header><p>
<a href="#censorRuleSetName">Name</a> | <a href="#ruleSetAction">Rule Set Action</a> | <a href="#censorRuleSetEnabled">Enabled</a> | <a href="#censorRuleSet">Rules Definition</a></p></section>
<section class="toc-row"><header><a href="#VHlsrecaptcha">reCAPTCHA Protection</a></header><p>
<a href="#recaptchaSensitivity">Trigger Sensitivity</a></p></section>
<section class="toc-row"><header>Containers</header><p>
<a href="#bubbleWrap">Bubblewrap Container</a> | <a href="#namespace">Namespace Container</a> | <a href="#namespaceConfVhAdd">Additional Namespace Template File</a></p></section>
<section class="toc-row"><header><a href="#vhHotlink">Hotlink Protection</a></header><p>
<a href="#enableHotlinkCtrl">Enable Hotlink Protection</a> | <a href="#suffixes">Suffix</a> | <a href="#redirectUri">Redirect URL</a> | <a href="#allowDirectAccess">Allow Direct Access</a> | <a href="#onlySelf">Only Self Reference</a> | <a href="#allowedHosts">Allowed Domains</a> | <a href="#matchedHosts">REGEX Matched Domains</a></p></section>
<section class="toc-row"><header><a href="#accessControl">Access Control</a></header><p>
<a href="#accessControl_allow">Allowed List</a> | <a href="#accessControl_deny">Denied List</a></p></section>
<section class="toc-row"><header><a href="#realms">Authorization Realms</a></header><p>
<a href="#realmName">Realm Name</a> | <a href="#realmType">DB Type</a> | <a href="#userDBLocation">User DB Location</a> | <a href="#userDB_attrPasswd">Password Attribute</a> | <a href="#userDB_attrMemberOf">Member-of Attribute</a> | <a href="#userDBMaxCacheSize">User DB Max Cache Size</a> | <a href="#userDBCacheTimeout">User DB Cache Timeout (secs)</a> | <a href="#GroupDBLocation">Group DB Location</a> | <a href="#groupDB_attrGroupMember">Group Member Attribute</a> | <a href="#groupDBMaxCacheSize">Group DB Max Cache Size</a> | <a href="#groupDBCacheTimeout">Group DB Cache Timeout (secs)</a> | <a href="#LDAPBindDN">LDAP Bind DN</a> | <a href="#LDAPBindPasswd">LDAP Bind Password</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="wpProtectAction"><h3>Protection Mode<span class="ls-permlink"><a href="#wpProtectAction"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the action to be taken when the specified Allowed Login Attempts limit is reached within 5 minutes.<br/><br/> <span class="val">Throttle</span> gradually slows down the speed of the server response, <span class="val">Drop</span> severs the connection without any reply, <span class="val">Deny</span> returns a 403 response, and <span class="val">CAPTCHA or Drop</span> redirects to a CAPTCHA if reCAPTCHA Protection is enabled and drops otherwise.<br/><br/> <span class="val">WP Login CAPTCHA Full Protection</span> can also be selected. This setting will redirect to a CAPTCHA if ReCAPTCHA Protection is enabled regardless of Allowed Login Attempts limit and falls back to use <span class="val">Throttle</span> otherwise.<br/><br/> Default values:<br/> <b>Server level:</b> <span class="val">Throttle</span><br/> <b>VH level:</b> Inherit Server level setting. If Server level is set to <span class="val">Disable</span>, <span class="val">Throttle</span> will be used.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.<br/> <span title="Information" class="ls-icon-info"></span> This feature is enabled by default (Throttle) and does not need any further configuration in the WebAdmin GUI or in Apache configurations.<br/> <span title="Information" class="ls-icon-info"></span> This setting will override Apache conf <span class="val">WordPressProtect</span> setting for LSWS only. Apache will be unaffected.<br/><br/> <span title="Information" class="ls-icon-info"></span> This can be set at the Server level and overwritten at the Virtual Host level. If not overridden at the Virtual Host level, this setting can also be overridden in a user's docroot .htaccess file using Apache configuration directive <span class="val">WordPressProtect</span> with value <span class="val">0</span> (disabled), <span class="val">1</span> (use server level setting), <span class="val">throttle</span>, <span class="val">deny</span>, or <span class="val">drop</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="wpProtectLimit"><h3>Allowed Login Attempts<span class="ls-permlink"><a href="#wpProtectLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of wp-login.php and xmlrpc.php POST attempts allowed by an IP within 5 minutes before the action specified in <span class="tagl"><a href="#wpProtectAction">Protection Mode</a></span> is taken.<br/><br/> This limit is handled using a quota system where remaining attempts = limit. Each POST attempt will decrease the number of remaining attempts by 1, with the number of remaining attempts increasing back to the set limit over time. An IP will be throttled once the number of remaining attempts for that IP falls to 1/2 the set limit, throttling more as the remaining attempts drops further below the 1/2 mark. When remaining attempts reaches 0, the specified action is taken toward the IP.<br/><br/> In addition to this, if <span class="tagl"><a href="#enableRecaptcha">Enable reCAPTCHA</a></span> is also enabled, an additional per worker protection will be added. If wp-login.php and xmlrpc.php are visited by the same worker at a rate of 4x the set limit in a 30 second time frame, those URLs will be put into reCAPTCHA mode until the number of visits to these files decreases.<br/><br/> Resetting the server will clear blocked IPs.<br/><br/> Default values:<br/> <b>Server-level:</b> <span class="val">10</span><br/> <b>VH-Level:</b> Inherit Server level setting</p> <h4>Syntax</h4><p>Valid Range: 3 - 1000.</p> <h4>Example</h4><div class="ls-example">With an Attempt limit of 10, and a Mode of drop:<br/><br/> After the first POST attempt, the quota is decreased to 9.<br/><br/> Quota decreases by 1 for each POST attempt.<br/><br/> After Quota reaches half of the limit (5), the IP will be throttled.<br/><br/> Throttling will get worse with each POST attempt.<br/><br/> Once the quota reaches 0, the connection will be dropped.</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks are not affected.<br/><br/> <span title="Information" class="ls-icon-info"></span> This setting will override Apache conf <span class="val">WordPressProtect</span> setting for LSWS only. Apache will be unaffected.<br/><br/> <span title="Information" class="ls-icon-info"></span> This can be set at the Server level and overwritten at the Virtual Host level. If not overridden at the Virtual Host level, this setting can also be overridden in a user's docroot .htaccess file using Apache configuration directive <span class="val">WordPressProtect</span> with integer value between 3 and 1000.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableCensorship"><h3>Enable WAF<span class="ls-permlink"><a href="#enableCensorship"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable request content deep inspection. This feature is equivalent to Apache's mod_security, which can be used to detect and block requests with ill intention by matching them to known signatures.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="censorLogLevel"><h3>Log Level<span class="ls-permlink"><a href="#censorLogLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the level of detail of the Web Application Firewall engine's debug output. This value ranges from <span class="val">0</span> - <span class="val">9</span>. <span class="val">0</span> disables logging. <span class="val">9</span> produces the most detailed log. The the server and virtual host's error log <span class="tagl"><a href="ServGeneral_Help.html#log_logLevel">Log Level</a></span> must be set to at least <span class="val">INFO</span> for this option to take effect. This is useful when testing request filtering rules.</p> <h4>Syntax</h4><p>Integer number</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#log_logLevel">Log Level</a></span>, Virtual Host <span class="tagl"><a href="VHGeneral_Help.html#vhlog_logLevel">Log Level</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultAction"><h3>Default Action<span class="ls-permlink"><a href="#defaultAction"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the default actions that should be taken when a censoring rule is met. Default value is <span class="val">deny,log,status:403</span>, which means to deny access with status code 403 and log the incident in the error log.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#ruleSetAction">Rule Set Action</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="scanPOST"><h3>Scan Request Body<span class="ls-permlink"><a href="#scanPOST"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to check the body of an HTTP POST request. Default is "No".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="reqCensorshipRule"><h3>Web Application Firewall (WAF) Rule Set<span class="ls-permlink"><a href="#reqCensorshipRule"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Rules configured here only work for virtual hosts configured with a native LSWS configuration, not for virtual hosts using Apache httpd.conf.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="censorRuleSetName"><h3>Name<span class="ls-permlink"><a href="#censorRuleSetName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Give a group of censorship rules a name. For display only.</p> <h4>Syntax</h4><p>String</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ruleSetAction"><h3>Rule Set Action<span class="ls-permlink"><a href="#ruleSetAction"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the actions that should be taken when a censoring rule in current ruleset is met. If not set, <span class="tagl"><a href="#defaultAction">Default Action</a></span> will be used.</p> <h4>Syntax</h4><p>String. This action string uses the same syntax as Apache's <a href=" https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecDefaultAction " target="_blank" rel="noopener noreferrer"> mod_security SecDefaultAction directive </a> .</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="censorRuleSetEnabled"><h3>Enabled<span class="ls-permlink"><a href="#censorRuleSetEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable this rule set. With this option, a rule set can be quickly turned on and off without adding or removing the rule set. Default is "Yes".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="censorRuleSet"><h3>Rules Definition<span class="ls-permlink"><a href="#censorRuleSet"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a list of censorship rules.<br/><br/> If you are using an Apache config file, you have to set up rules in httpd.conf. Rules defined here will have no effect.</p> <h4>Syntax</h4><p>String. Syntax of censoring rules follows that of Apache's mod_security directives. "SecFilter", "SecFilterSelective", and "SecRule" can be used here. You can copy and paste security rules from an Apache configuration file.<br/><br/> For more details about rule syntax, please refer to the <a href="http://www.modsecurity.org/documentation/index.html" target="_blank" rel="noopener noreferrer">Mod Security documentation</a>.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Rules configured here only work for vhosts configured in native LSWS configuration, not for vhosts from Apache httpd.conf.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="VHlsrecaptcha"><h3>reCAPTCHA Protection<span class="ls-permlink"><a href="#VHlsrecaptcha"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>reCAPTCHA Protection is a service provided as a way to mitigate heavy server load. reCAPTCHA Protection will activate after one of the below situations is hit. Once active, all requests by NON TRUSTED(as configured) clients will be redirected to a reCAPTCHA validation page. After validation, the client will be redirected to their desired page.<br/><br/> The following situations will activate reCAPTCHA Protection:<br/> 1. The server or vhost concurrent requests count passes the configured connection limit.<br/> 2. Anti-DDoS is enabled and a client is hitting a url in a suspicious manner. The client will redirect to reCAPTCHA first instead of getting denied when triggered.<br/> 3. WordPress Brute Force Attack Protection is enabled and action is set to 'CAPTCHA or Drop’. When a brute force attack is detected, the client will redirect to reCAPTCHA first. After max tries is reached, the connection will be dropped, as per the ‘drop’ option.<br/> 4. WordPress Brute Force Attack Protection is enabled and action is set to 'WP Login CAPTCHA Full Protection'. The client will always redirect to reCAPTCHA first.<br/> 5. A new rewrite rule environment is provided to activate reCAPTCHA via RewriteRules. 'verifycaptcha' can be set to redirect clients to reCAPTCHA. A special value ': deny' can be set to deny the client if it failed too many times. For example, [E=verifycaptcha] will always redirect to reCAPTCHA until verified. [E=verifycaptcha: deny] will redirect to reCAPTCHA until Max Tries is hit, after which the client will be denied.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="recaptchaSensitivity"><h3>Trigger Sensitivity<span class="ls-permlink"><a href="#recaptchaSensitivity"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Automatic reCAPTCHA sensitivity. The higher the value, the more likely reCAPTCHA Protection will be used. A value of <span class="val">0</span> is equivalent to "Off" while a value of <span class="val">100</span> is equivalent to "Always On".<br/><br/> Default values:<br/> <b>Server level:</b> 0<br/> <b>Virtual Host level:</b> Inherit Server level setting</p> <h4>Syntax</h4><p>Integer value between 0 and 100.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="bubbleWrap"><h3>Bubblewrap Container<span class="ls-permlink"><a href="#bubbleWrap"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set to <span class="val">Enabled</span> if you wish to start CGI processes (including PHP programs) in a bubblewrap sandbox. See <a href=" https://wiki.archlinux.org/title/Bubblewrap " target="_blank" rel="noopener noreferrer"> https://wiki.archlinux.org/title/Bubblewrap </a> for details on using bubblewrap. Bubblewrap must be installed on your system prior to using this setting.<br/><br/> This setting cannot be turned on at the Virtual Host level if set to "Disabled" at the Server level.<br/><br/> Default values:<br/> <b>Server level:</b> Disabled<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"><div><header id="namespace"><h3>Namespace Container<span class="ls-permlink"><a href="#namespace"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set to <span class="val">Enabled</span> if you wish to start CGI processes (including PHP programs) in a namespace container sandbox. Only used when <span class="tagl"><a href="ServSecurity_Help.html#bubbleWrap">Bubblewrap Container</a></span> is set to <span class="val">Disabled</span>.<br/><br/> When not <span class="val">Disabled</span> at the Server level, this settings value can be overridden at the Virtual Host level.<br/><br/> Default values:<br/> <b>Server level:</b> <span class="val">Disabled</span><br/> <b>Virtual Host 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"><div><header id="namespaceConfVhAdd"><h3>Additional Namespace Template File<span class="ls-permlink"><a href="#namespaceConfVhAdd"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Path to an existing configuration file containing a list of directories to be mounted along with the methods used to mount them. If <span class="tagl"><a href="ServSecurity_Help.html#namespaceConf">Namespace Template File</a></span> is also set at the Server level, both files will be used.</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"><div><header id="vhHotlink"><h3>Hotlink Protection<span class="ls-permlink"><a href="#vhHotlink"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Hotlinks are requests made from an external website to files on your own website often referred to as "leeching". This practice introduces additional bandwidth usage that you should not be responsible for.<br/><br/> LiteSpeed web server can prevent others from hotlinking to content on your web site by checking the Referer header within an HTTP request. If the Referer header does not match your website, the request will be denied.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableHotlinkCtrl"><h3>Enable Hotlink Protection<span class="ls-permlink"><a href="#enableHotlinkCtrl"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to activate hotlink protection.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="suffixes"><h3>Suffix<span class="ls-permlink"><a href="#suffixes"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what kinds of files will be protected from hotlinking by listing file suffixes.</p> <h4>Syntax</h4><p>Comma delimited list. "." is prohibited</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="redirectUri"><h3>Redirect URL<span class="ls-permlink"><a href="#redirectUri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a URL that a user will be redirected to when a hotlinking action is detected. You can redirect users to an image or page saying hotlinking is not allowed. If it is not specified, <span class="val">403 Forbidden</span> will be returned.</p> <h4>Syntax</h4><p>Absolute URL</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowDirectAccess"><h3>Allow Direct Access<span class="ls-permlink"><a href="#allowDirectAccess"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to allow direct access without a referrer. A referrer header identifies the web page that linked to the current page. There is no "referrer" header in HTTP requests when a user types in an address directly in the address box or uses a feature like "save target link as".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="onlySelf"><h3>Only Self Reference<span class="ls-permlink"><a href="#onlySelf"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to only allow references from the current web site itself. When set to <span class="val">Yes</span>, <span class="tagl"><a href="#allowedHosts">Allowed Domains</a></span> has no effect and no other web site can link to protected files. This can be convenient if you wish to park multiple domain names on the current web site.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowedHosts"><h3>Allowed Domains<span class="ls-permlink"><a href="#allowedHosts"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which web sites can link to protected content.</p> <h4>Syntax</h4><p>Comma delimited list of domain names.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="matchedHosts"><h3>REGEX Matched Domains<span class="ls-permlink"><a href="#matchedHosts"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies web sites that can link to protected content in regular expressions. The regular expression will match the domain name only and not the full URL.</p> <h4>Syntax</h4><p>Regular expressions</p> <h4>Example</h4><div class="ls-example">^.*\.mydomain\.com$</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessControl"><h3>Access Control<span class="ls-permlink"><a href="#accessControl"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what sub networks and/or IP addresses can access the server. At the server level, this setting will affect all virtual hosts. You can also set up access control unique to each virtual host at the virtual host level. Virtual host level settings will NOT override server level settings.<br/><br/> Blocking/Allowing an IP is determined by the combination of the allowed list and the denied list. If you want to block only certain IPs or sub-networks, put <span class="val">*</span> or <span class="val">ALL</span> in the <span class="tagl"><a href="#accessControl_allow">Allowed List</a></span> and list the blocked IPs or sub-networks in the <span class="tagl"><a href="#accessControl_deny">Denied List</a></span>. If you want to allow only certain IPs or sub-networks, put <span class="val">*</span> or <span class="val">ALL</span> in the <span class="tagl"><a href="#accessControl_deny">Denied List</a></span> and list the allowed IPs or sub-networks in the <span class="tagl"><a href="#accessControl_allow">Allowed List</a></span>. The setting of the smallest scope that fits for an IP will be used to determine access.<br/><br/> <b>Server Level:</b> Trusted IPs or sub-networks must be specified in the <span class="tagl"><a href="#accessControl_allow">Allowed List</a></span> by adding a trailing "T". Trusted IPs or sub-networks are not affected by connection/throttling limits. Only server level access control can set up trusted IPs/sub-networks.</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Use this at the server level for general restrictions that apply to all virtual hosts.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessControl_allow"><h3>Allowed List<span class="ls-permlink"><a href="#accessControl_allow"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the list of IPs or sub-networks allowed. <span class="val">*</span> or <span class="val">ALL</span> are accepted.</p> <h4>Syntax</h4><p>Comma delimited list of IP addresses or sub-networks. A trailing "T" can be used to indicate a trusted IP or sub-network, such as <span class="val">192.168.1.*T</span>.</p> <h4>Example</h4><div class="ls-example"><b>Sub-networks:</b> 192.168.1.0/255.255.255.0, 192.168.1.0/24, 192.168.1, or 192.168.1.*<br/> <b>IPv6 addresses:</b> ::1 or [::1]<br/> <b>IPv6 subnets:</b> 3ffe:302:11:2:20f:1fff:fe29:717c/64 or [3ffe:302:11:2:20f:1fff:fe29:717c]/64</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Trusted IPs or sub-networks set at the server level access control will be excluded from connection/throttling limits.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessControl_deny"><h3>Denied List<span class="ls-permlink"><a href="#accessControl_deny"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the list of IPs or sub-networks disallowed.</p> <h4>Syntax</h4><p>Comma delimited list of IP addresses or sub-networks. <span class="val">*</span> or <span class="val">ALL</span> are accepted.</p> <h4>Example</h4><div class="ls-example"><b>Sub-networks:</b> 192.168.1.0/255.255.255.0, 192.168.1.0/24, 192.168.1, or 192.168.1.*<br/> <b>IPv6 addresses:</b> ::1 or [::1]<br/> <b>IPv6 subnets:</b> 3ffe:302:11:2:20f:1fff:fe29:717c/64 or [3ffe:302:11:2:20f:1fff:fe29:717c]/64</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realms"><h3>Authorization Realms<span class="ls-permlink"><a href="#realms"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Lists all authorization realms for this virtual host. Authorization realms are used to block unauthorized users from accessing protected web pages. A realm is a user directory containing usernames and passwords with optional group classifications. Authorization is performed at the context level. Because different contexts can share the same realm (user database), realms are defined separately from the contexts that use them. You can refer to a realm by these names in a contexts configuration.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realmName"><h3>Realm Name<span class="ls-permlink"><a href="#realmName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a unique name for the authorization realm.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realmType"><h3>DB Type<span class="ls-permlink"><a href="#realmType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how user/group data is stored for an authorization realm. Currently, user/group data can be stored in flat files or on a LDAP server.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="userDBLocation"><h3>User DB Location<span class="ls-permlink"><a href="#userDBLocation"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the user database. For DB type <span class="val">Password File</span>, it is the path to the flat file containing user/password definitions. You can edit this file through the WebAdmin console by clicking on the filename.<br/><br/> Each line of the user file contains a username followed by a colon, followed by a crypt() encrypted password, optionally followed by a colon and group names that user belongs to. Group names are delimitated by commas. If group information is specified in the user database, then the group database will not be checked.<br/><br/> Example:<blockquote><code>john:HZ.U8kgjnMOHo:admin,user</code></blockquote><br/><br/> For DB type <span class="val">LDAP</span>, it is the LDAP URL to query for the user information. For each valid user, the authentication data stored in the LDAP server should contain at least the user id and user password. One and only one record should be returned in the LDAP search request based on the URL and username received in the HTTP Authentication header. "$k" must be specified in the filter part of the URL and it will be replaced with the username. The user password attribute must be returned in the query result. The attribute name of the user password is specified by <span class="tagl"><a href="#userDB_attrPasswd">Password Attribute</a></span>. Group information can be optionally specified by the <span class="tagl"><a href="#userDB_attrMemberOf">Member-of Attribute</a></span>.<br/><br/> Example: At minimum, a user can be defined in LDAP with object classes: uidObject, simpleSecurityObject and organizationalRole. The following URL could be used:<br/><br/> <blockquote><code>ldap://localhost/ou=UserDB,dc=example,dc=com???(&(objectClass=*)(uid=$k))</code></blockquote></p> <h4>Syntax</h4><p>Path to user DB file or LDAP URL (RFC 2255).</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> It is recommended to store user password files outside of the document tree. If a user password file has to be placed inside document tree, simply name it with a leading ".ht" like <span class="val">.htuser</span> to prevent it being served as a static file. LiteSpeed Web Server does not serve files prefixed with ".ht".</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#GroupDBLocation">Group DB Location</a></span>, <span class="tagl"><a href="#userDB_attrPasswd">Password Attribute</a></span>, <span class="tagl"><a href="#userDB_attrMemberOf">Member-of Attribute</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="userDB_attrPasswd"><h3>Password Attribute<span class="ls-permlink"><a href="#userDB_attrPasswd"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the password attribute for a user record stored in an LDAP server. The default value is <span class="val">userPassword</span>.</p> <h4>Syntax</h4><p>string</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="userDB_attrMemberOf"><h3>Member-of Attribute<span class="ls-permlink"><a href="#userDB_attrMemberOf"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the "Member-of" attribute for a user record stored in an LDAP server. The default value is <span class="val">memberOf</span>. The "Member-of" attribute can be used to specify the group name that the user belongs to.</p> <h4>Syntax</h4><p>string</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="userDBMaxCacheSize"><h3>User DB Max Cache Size<span class="ls-permlink"><a href="#userDBMaxCacheSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum cache size of the user database. Recently accessed user authentication data will be cached in memory to provide maximum performance.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> As a larger cache will consume more memory, a higher value may or may not provide better performance. Set it to an appropriate size according to your user database size and site usage.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="userDBCacheTimeout"><h3>User DB Cache Timeout (secs)<span class="ls-permlink"><a href="#userDBCacheTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how often the backend user database will be checked for changes. Every entry in the cache has a timestamp. When cached data is older than the specified timeout, the backend database will be checked for changes. If there is no change, the timestamp will be reset to the current time, otherwise the new data will be loaded. Sevrer reload and graceful restart will clear the cache immediately.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If the backend database does not change very often, set a longer timeout for better performance.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="GroupDBLocation"><h3>Group DB Location<span class="ls-permlink"><a href="#GroupDBLocation"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the group database.<br/><br/> Group information can be set either in the user database or in this standalone group DB. For user authentication, the user DB will be checked first. If the user DB also contains group information, then the group DB will not be checked.<br/><br/> For the DB type <span class="val">Password File</span>, the group DB location should be the path to the flat file containing group definitions. You can edit this file through the WebAdmin console by clicking on the filename.<br/><br/> Each line of a group file should contain a groupname followed by a colon, followed by space delimited group of usernames. Example:<br/> <blockquote><code>testgroup: user1 user2 user3</code></blockquote><br/><br/> For the DB type <span class="val">LDAP</span>, the group DB location should be the LDAP URL to query for group information. For each valid group, one and only one record should be returned in the LDAP search request based on this URL and the group name specified in <span class="tagl"><a href="Redirect_Context.html#required">Require (Authorized Users/Groups)</a></span>. "$k" must be specified in the filter part of the URL and it will be replaced with the group name. The name of the attribute that specifies members in this group is specified by the <span class="tagl"><a href="#groupDB_attrGroupMember">Group Member Attribute</a></span>.<br/><br/> Example: If objectClass posixGroup is being used to store group information. The following URL could be used:<br/> <blockquote><code>ldap://localhost/ou=GroupDB,dc=example,dc=com???(&(objectClass=*)(cn=$k))</code></blockquote></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 title="Security" class="ls-icon-security"></span> It is recommended to store a group file outside the document tree. If it has to be placed inside document tree, simply name it with a leading ".ht" like <span class="val">.htgroup</span>, to prevent the file being served as a static file. LiteSpeed Web Server does not serve files prefixed with ".ht".</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#userDBLocation">User DB Location</a></span>, Context <span class="tagl"><a href="Context_Help.html#required">Require (Authorized Users/Groups)</a></span>, <span class="tagl"><a href="#groupDB_attrGroupMember">Group Member Attribute</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="groupDB_attrGroupMember"><h3>Group Member Attribute<span class="ls-permlink"><a href="#groupDB_attrGroupMember"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the "Member" attribute for a group record stored in an LDAP server. The default value is <span class="val">memberUid</span>.</p> <h4>Syntax</h4><p>string</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="groupDBMaxCacheSize"><h3>Group DB Max Cache Size<span class="ls-permlink"><a href="#groupDBMaxCacheSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum cache size of the group database.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> As a larger cache will consume more memory, a higher value may or may not provide better performance. Set it to an appropriate size according to your user database size and site usage.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#userDBMaxCacheSize">User DB Max Cache Size</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="groupDBCacheTimeout"><h3>Group DB Cache Timeout (secs)<span class="ls-permlink"><a href="#groupDBCacheTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how often the backend group database will be checked for changes. For more detail please refer to <span class="tagl"><a href="#userDBCacheTimeout">User DB Cache Timeout (secs)</a></span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#userDBCacheTimeout">User DB Cache Timeout (secs)</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="LDAPBindDN"><h3>LDAP Bind DN<span class="ls-permlink"><a href="#LDAPBindDN"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a DN used to bind to the server. If the LDAP server requires authentication, a bind DN and password must be specified. If not specified, anonymous bind will be used.</p> <h4>Syntax</h4><p>string</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#LDAPBindPasswd">LDAP Bind Password</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="LDAPBindPasswd"><h3>LDAP Bind Password<span class="ls-permlink"><a href="#LDAPBindPasswd"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a password used to bind to the server. If the LDAP Server requires authentication, a bind DN and password must be specified.</p> <h4>Syntax</h4><p>string</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#LDAPBindDN">LDAP Bind DN</a></span></p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
External_WS.html 0000644 00000026371 15055121352 0007635 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Web Server</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Web Server." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><span class="current"><a href="External_WS.html">Web Server</a></span></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="External_Servlet.html">Servlet Engine</a></div><div class="center"><a href="ExtApp_Help.html">External Apps</a></div><div class="next"><a href="External_PL.html">Piped Logger</a> »</div></div>
<h1>Web Server</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Web Server</header><p>
<a href="#extAppName">Name</a> | <a href="#expWSAddress">Address</a> | <a href="#maxConns">Max Connections</a> | <a href="#pcKeepAliveTimeout">Connection Keepalive Timeout</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#respBuffer">Response Buffering</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="extAppName"><h3>Name<span class="ls-permlink"><a href="#extAppName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this external application. You will refer to it by this name when you use it in other parts of the configuration.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expWSAddress"><h3>Address<span class="ls-permlink"><a href="#expWSAddress"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>HTTP,HTTPS, or Unix Domain Sockets (UDS) address used by the external web server.</p> <h4>Syntax</h4><p>IPv4/IPv6 address(:port), UDS://path, or unix:path. Add "https://" in front of an IPv4/IPv6 address if the external web server uses HTTPS. Port is optional for IPv4/IPv6 addresses if the external web server uses the standard ports 80 or 443.</p> <h4>Example</h4><div class="ls-example">192.168.0.10<br/> 127.0.0.1:5434<br/> https://10.0.8.9<br/> https://127.0.0.1:5438<br/> UDS://tmp/lshttpd/php.sock<br/> unix:/tmp/lshttpd/php.sock</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If you proxy to another web server running on the same machine using an IPv4/IPv6 address, set the IP address to <span class="val">localhost</span> or <span class="val">127.0.0.1</span>, so the external application is inaccessible from other machines.<br/> <span title="Performance" class="ls-icon-performance"></span> Unix Domain Sockets generally provide higher performance than IPv4 or IPv6 sockets.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pcKeepAliveTimeout"><h3>Connection Keepalive Timeout<span class="ls-permlink"><a href="#pcKeepAliveTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds to keep an idle persistent connection open.<br/><br/> When set to "-1", the connection will never timeout. When set to 0 or greater, the connection will be closed after this time in seconds has passed.</p> <h4>Syntax</h4><p>int</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="initTimeout"><h3>Initial Request Timeout (secs)<span class="ls-permlink"><a href="#initTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds the server will wait for the external application to respond to the first request over a new established connection. If the server does not receive any data from the external application within this timeout limit, it will mark this connection as bad. This helps to identify communication problems with external applications as quickly as possible. If some requests take longer to process, increase this limit to avoid 503 error messages.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="retryTimeout"><h3>Retry Timeout (secs)<span class="ls-permlink"><a href="#retryTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the period of time that the server waits before retrying an external application that had a prior communication problem.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="respBuffer"><h3>Response Buffering<span class="ls-permlink"><a href="#respBuffer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to buffer responses received from external applications. If a "nph-" (Non-Parsed-Header) script is detected, buffering is turned off for responses with full HTTP headers.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
ServLog_Help.html 0000644 00000044704 15055121352 0007773 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Server Log</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Server Log." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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><span class="current"><a href="ServLog_Help.html">Server Log</a></span></li>
<li><a href="ServTuning_Help.html">Server Tuning</a></li>
<li><a href="ServSecurity_Help.html">Server Security</a></li>
<li><a href="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="ServGeneral_Help.html">Server General</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="ServTuning_Help.html">Server Tuning</a> »</div></div>
<h1>Server Log</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Server Log</header><p>
<a href="#log_fileName">File Name</a> | <a href="#log_logLevel">Log Level</a> | <a href="#log_debugLevel">Debug Level</a> | <a href="#log_rollingSize">Rolling Size (bytes)</a> | <a href="#log_keepDays">Keep Days</a> | <a href="#log_compressArchive">Compress Archive</a> | <a href="#log_enableStderrLog">Enable stderr Log</a> | <a href="#log_enableAioLog">Enable AIO Logging</a></p></section>
<section class="toc-row"><header>Access Log</header><p>
<a href="#accessLog_fileName">File Name</a> | <a href="#accessLog_pipedLogger">Piped Logger</a> | <a href="#accessLog_logFormat">Log Format</a> | <a href="#accessLog_logHeader">Log Headers</a> | <a href="#log_rollingSize">Rolling Size (bytes)</a> | <a href="#log_keepDays">Keep Days</a> | <a href="#log_compressArchive">Compress Archive</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="log_fileName"><h3>File Name<span class="ls-permlink"><a href="#log_fileName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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.</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Place the log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="log_logLevel"><h3>Log Level<span class="ls-permlink"><a href="#log_logLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the level of logging to include in your log file. 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 level higher or equal to the current setting will be logged.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Using <span class="val">DEBUG</span> log level does not have any performance impact, unless <span class="tagl"><a href="#log_debugLevel">Debug Level</a></span> is set to a level other than <span class="val">NONE</span>. It's recommended to set Log Level to <span class="val">DEBUG</span> and Debug Level to <span class="val">NONE</span>. These settings mean that you will not fill up your hard disk with debug logging, but you will be able to use the <span class="tagl"><a href="ServerStat_Help.html#toggleDebugLog">Toggle Debug Logging</a></span> action to control debug output. This action can turn debug logging on and off on the fly, and is useful for debugging busy production servers.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#log_debugLevel">Debug Level</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="log_debugLevel"><h3>Debug Level<span class="ls-permlink"><a href="#log_debugLevel"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the level of debug logging. <span class="tagl"><a href="#log_logLevel">Log Level</a></span> must be set to <span class="val">DEBUG</span> to use this feature. Debug logging is disabled when "Debug Level" is set to <span class="val">NONE</span> even if <span class="tagl"><a href="#log_logLevel">Log Level</a></span> is set to <span class="val">DEBUG</span>. <span class="tagl"><a href="ServerStat_Help.html#toggleDebugLog">Toggle Debug Logging</a></span> can be used to control debug level on a live server without restarting.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Important! Always set this to <span class="val">NONE</span> if you do not need detailed debug logging. Active debug logging will severely degrade service performance and potentially saturate disk space in a very short time. Debug logging includes detailed information for each request and response.<br/><br/> It's recommended to set Log Level to <span class="val">DEBUG</span> and Debug Level to <span class="val">NONE</span>. These settings mean that you will not fill up your hard disk with debug logging, but you will be able to use the <span class="tagl"><a href="ServerStat_Help.html#toggleDebugLog">Toggle Debug Logging</a></span> action to control debug output. This action can turn debug logging on and off on the fly, and is useful for debugging busy production servers.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#log_logLevel">Log Level</a></span>, <span class="tagl"><a href="ServerStat_Help.html#toggleDebugLog">Toggle Debug Logging</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="log_rollingSize"><h3>Rolling Size (bytes)<span class="ls-permlink"><a href="#log_rollingSize"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></span> Append "K", "M", "G" to the number for kilo-, mega- and giga- bytes.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="log_keepDays"><h3>Keep Days<span class="ls-permlink"><a href="#log_keepDays"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="log_compressArchive"><h3>Compress Archive<span class="ls-permlink"><a href="#log_compressArchive"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Information" class="ls-icon-info"></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"><div><header id="log_enableStderrLog"><h3>Enable stderr Log<span class="ls-permlink"><a href="#log_enableStderrLog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to write to log when receiving stderr output from processes started by the server.<br/><br/> If enabled, stderr messages will be logged in the same directory as the server log with the fixed name "stderr.log". If disabled, all stderr output will be discarded.<br/><br/> Functions like PHP's error_log() which do not write directly to stderr (file handle 2) are not affected by this setting and will write to the file set in PHP ini directive 'error_log' or the server's "error.log" file with tag '[STDERR]' if that directive is not set.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Turn it on if you need to debug configured external applications: i.e. PHP, Ruby, Java, Python, Perl.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="log_enableAioLog"><h3>Enable AIO Logging<span class="ls-permlink"><a href="#log_enableAioLog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable AIO logging for server log and access log. If enabled, asynchronous I/O will be used for writing log messages.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling AIO logging can help overall server performance when server I/O wait is high.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessLog_fileName"><h3>File Name<span class="ls-permlink"><a href="#accessLog_fileName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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.</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Put access log file on a separate disk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessLog_pipedLogger"><h3>Piped Logger<span class="ls-permlink"><a href="#accessLog_pipedLogger"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="accessLog_logFormat"><h3>Log Format<span class="ls-permlink"><a href="#accessLog_logFormat"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="accessLog_logHeader"><h3>Log Headers<span class="ls-permlink"><a href="#accessLog_logHeader"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-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>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Context_Help.html 0000644 00000017567 15055121352 0010045 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><span class="current"><a href="Context_Help.html">Context</a></span></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Rewrite_Help.html">Rewrite</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="VHAddOns_Help.html">Add-ons</a> »</div></div>
<h1>Context</h1><section class="ls-spacer-small-bottom">In LiteSpeed Web Server terminology, a "context" is a virtual location, a common parent URL,
that identifies a group of resources. Contexts can be thought of as different directories
in your website's directory tree. For example, "/" is the root context mapped to the
document root of a website. "/cgi-bin/" is a context farther up on the tree, dedicated
to the CGI applications for this site. A context can be explicitly defined in
LiteSpeed's WebAdmin console for the following purposes:
<ul>
<li>To make a file system outside of the document root accessible.</li>
<li>To block access to certain resources.</li>
<li>To setup user-level authentication for certain resources.</li>
<li>To create mount points for external applications.</li>
<li>To redirect requests to another location.</li>
</ul></section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Context Attributes</header><p>
<a href="#ctxType">Context Type</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="ctxType"><h3>Context Type<span class="ls-permlink"><a href="#ctxType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The type of context created determines it's usage.:<br><br><b>Static</b> context can be used to map a URI to a directory either outside document root or within it.<br> <b>Java Web App</b> context is used to automatically import a predefined Java Application in an AJPv13 compilant Java servlet engine.<br> <b>Servlet</b> context is used to import a specific servlet under a web application.<br> <b>Fast CGI</b> context is a mount point of Fast CGI application.<br> <b>LiteSpeed SAPI</b> context can be used to associate a URI with an LSAPI application.<br> <b>Proxy</b> context enables this virtual host to serve as a transparant reverse proxy server to an external web server or application server.<br> <b>CGI</b> context can be used to specify a directory only contains CGI scripts.<br> <b>Load Balancer</b> context can be used to assign a different cluster for that context.<br> <b>Redirect</b> context can set up an internal or external redirect URI.<br> <b>App Server</b> context is used for Rack/Rails, WSGI, or Node.js applications.<br> <b>Rack/Rails</b> context is specifically used for Rack/Rails applications. It is recommended to configure Rack/Rails applications as an <b>App Server</b> context instead.<br></p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Static_Context.html 0000644 00000114576 15055121352 0010402 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Static Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Static Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<ul class="level3">
<li><span class="current"><a href="Static_Context.html">Static Context</a></span></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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev"> </div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="Java_Web_App_Context.html">Java Web App Context</a> »</div></div>
<h1>Static Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#generalContext">Static Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#location">Location</a> | <a href="#allowBrowse">Accessible</a> | <a href="#enableExpires">Enable Expires</a> | <a href="#expiresDefault">Expires Default</a> | <a href="#expiresByType">Expires By Type</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#addMIMEType">MIME Type</a> | <a href="#forceType">Force MIME Type</a> | <a href="#defaultType">Default MIME Type</a> | <a href="#indexFiles">Index Files</a> | <a href="#autoIndex">Auto Index</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#enableRewrite">Enable Rewrite</a> | <a href="#rewriteInherit">Rewrite Inherit</a> | <a href="#rewriteBase">Rewrite Base</a> | <a href="#rewriteRules">Rewrite Rules</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a> | <a href="#apacheConf">Apache Style Configurations</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="generalContext"><h3>Static Context<span class="ls-permlink"><a href="#generalContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Context settings are used to specify special settings for files in a certain location. These settings can be used to bring in files outside of the document root (like Apache's Alias or AliasMatch directives), to protect a particular directory using authorization realms, or to block or restrict access to a particular directory within the document root.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="location"><h3>Location<span class="ls-permlink"><a href="#location"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the corresponding location of this context in the file system.<br/><br/> Default value: $DOC_ROOT + <span class="tagl"><a href="#expuri">URI</a></span></p> <h4>Syntax</h4><p>It can be an absolute path or path relative to $SERVER_ROOT, $VH_ROOT, or $DOC_ROOT. $DOC_ROOT is the default relative path, and can be omitted.<br/><br/> If the <span class="tagl"><a href="#expuri">URI</a></span> is a regular expression, then the matched sub-string can be used to form the "Root" string. The matched sub-string can be referenced with the values "$1" - "$9". "$0" and "&" can be used to reference the whole matched string. Additionally, a query string can be set by appending a "?" followed by the query string. Be careful. "&" should be escaped as "\&" in the query string.</p> <h4>Example</h4><div class="ls-example">A plain URI like <span class="val">/examples/</span> with <span class="tagl"><a href="#location">Location</a></span> set to <span class="val">/home/john/web_examples</span> will map the request "/examples/foo/bar.html" to file "/home/john/web_examples/foo/bar.html".<br/> To simulate Apache's mod_userdir, set URI to <span class="val">exp: ^/~([A-Za-z0-9]+)(.*)</span>, set <span class="tagl"><a href="#location">Location</a></span> to <span class="val">/home/$1/public_html$2</span>. With these settings, a request of URI /~john/foo/bar.html will map to file /home/john/public_html/foo/bar.html.</div><h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#expuri">URI</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowBrowse"><h3>Accessible<span class="ls-permlink"><a href="#allowBrowse"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether this context can be accessed. Set to <span class="val">No</span> to deny access. You can use this feature to protect the specified directory from being visited. You may use it when you are updating contents for this context or you have special data in this directory.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableExpires"><h3>Enable Expires<span class="ls-permlink"><a href="#enableExpires"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresDefault"><h3>Expires Default<span class="ls-permlink"><a href="#expiresDefault"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresByType"><h3>Expires By Type<span class="ls-permlink"><a href="#expiresByType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addMIMEType"><h3>MIME Type<span class="ls-permlink"><a href="#addMIMEType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional MIME types and mappings for this context. New mappings will override existing mappings under this context and its children contexts.<br/> If you want to show PHP scripts as text files instead of being executed as scripts, just override the .php mapping to MIME type "text/plain".</p> <h4>Syntax</h4><p>MIME-type1 extension extension ..., MIME-type2 extension ... Use comma to separate between MIME types, use space to separate multiple extensions.</p> <h4>Example</h4><div class="ls-example"><span class="val">image/jpg jpeg jpg, image/gif gif</span></div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="forceType"><h3>Force MIME Type<span class="ls-permlink"><a href="#forceType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>When specified, all files under this context will be served as static files with the MIME type specified regardless of file suffix. When set to <span class="val">NONE</span>, inherited force type setting will be disabled.</p> <h4>Syntax</h4><p>MIME type or NONE.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultType"><h3>Default MIME Type<span class="ls-permlink"><a href="#defaultType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>When specified, this type will be used when MIME type mapping cannot be determined by the suffix of a document or if there is no suffix. If not specified, the default value <span class="val">application/octet-stream</span> will be used.</p> <h4>Syntax</h4><p>MIME-type</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="indexFiles"><h3>Index Files<span class="ls-permlink"><a href="#indexFiles"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Only set index files that you need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoIndex"><h3>Auto Index<span class="ls-permlink"><a href="#autoIndex"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Security" class="ls-icon-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"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableRewrite"><h3>Enable Rewrite<span class="ls-permlink"><a href="#enableRewrite"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable LiteSpeed's URL rewrite engine. This option can be customized at the virtual host or context level, and is inherited along the directory tree until it is explicitly overridden.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteInherit"><h3>Rewrite Inherit<span class="ls-permlink"><a href="#rewriteInherit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to inherit rewrite rules from parent contexts. If rewrite is enabled and not inherited, rewrite base and rewrite rules defined in this context will be used.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteBase"><h3>Rewrite Base<span class="ls-permlink"><a href="#rewriteBase"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the base URL for rewrite rules.</p> <h4>Syntax</h4><p>URL</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteRules"><h3>Rewrite Rules<span class="ls-permlink"><a href="#rewriteRules"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a list of rewrite rules at the virtual host level.<br/><br/> Do NOT add any document root level rewrite rules here. If you have any document root level rewrite rules from .htaccess, you should instead create a static context with uri "/" and add the rewrite rules there.<br/><br/> A rewrite rule is comprised of one <span class="val">RewriteRule</span> directive and optionally preceded by multiple <span class="val">RewriteCond</span> directives. <ul> <li>Each directive should take only one line.</li> <li> <span class="val">RewriteCond</span> and <span class="val">RewriteRule</span> follow Apache's rewrite directive syntax. Just copy and paste rewrite directives from your Apache configuration files. </li> <li> There are minor differences between LiteSpeed and Apache mod_rewrite implementation: <ul> <li> <span class="val">%\{LA-U:variable\}</span> and <span class="val">%\{LA-F:variable\}</span> are ignored by the LiteSpeed rewrite engine </li> <li> Two new server variables are added in the LiteSpeed rewrite engine: <span class="val">%\{CURRENT_URI\}</span> represents the current URI being processed by the rewrite engine and <span class="val">%\{SCRIPT_NAME\}</span> has the same meaning as the corresponding CGI environment variable. </li> <li> The LiteSpeed rewrite engine will stop processing rewrite rules after encountering an <span class="val">[L]</span> flag to avoid looping while Apache mod_rewrite will stop processing rewrite rules for the current iteration only. This behavior is similar to that of the <span class="val">[END]</span> flag in Apache mod_rewrite. </li> </ul> </li> </ul><br/> The implementation of LiteSpeed's rewrite engine follows Apache's rewrite engine specifications. For more details about rewrite rules, please refer to <a href="https://httpd.apache.org/docs/current/mod/mod_rewrite.html" target="_blank" rel="noopener noreferrer"> Apache's mod_rewrite document </a> and <a href="https://httpd.apache.org/docs/current/rewrite/" target="_blank" rel="noopener noreferrer"> Apache's URL rewriting guide </a>.</p> <h4>Syntax</h4><p>string</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheConf"><h3>Apache Style Configurations<span class="ls-permlink"><a href="#apacheConf"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies Apache configuration directives (supported by LiteSpeed) that you want to use in LiteSpeed native configuration file. For example, to override the default PHP configurations (php.ini entries) the server will need four directives: "php_value", "php_flag", "php_admin_value" and "php_admin_flag".</p> <h4>Syntax</h4><p>Same as Apache configuration file.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
VHSSL_Help.html 0000644 00000057056 15055121352 0007315 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Virtual Host SSL</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Virtual Host SSL." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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><span class="current"><a href="VHSSL_Help.html">Virtual Host SSL</a></span></li>
<li>
<a href="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="VHSecurity_Help.html">Virtual Host Security</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a> »</div></div>
<h1>Virtual Host SSL</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#sslCert">SSL Private Key & Certificate</a></header><p>
<a href="#keyFile">Private Key File</a> | <a href="#certFile">Certificate File</a> | <a href="#certChain">Chained Certificate</a> | <a href="#CACertPath">CA Certificate Path</a> | <a href="#CACertFile">CA Certificate File</a></p></section>
<section class="toc-row"><header>SSL Protocol</header><p>
<a href="#ciphers">Ciphers</a> | <a href="#enableECDHE">Enable ECDH Key Exchange</a> | <a href="#enableDHE">Enable DH Key Exchange</a> | <a href="#DHParam">DH Parameter</a></p></section>
<section class="toc-row"><header>Security & Features</header><p>
<a href="#renegProtection">SSL Renegotiation Protection</a> | <a href="#sslSessionCache">Enable Session Cache</a> | <a href="#sslSessionTickets">Enable Session Tickets</a> | <a href="#enableSpdy">ALPN</a> | <a href="#vhEnableQuic">Enable HTTP3/QUIC</a></p></section>
<section class="toc-row"><header><a href="#sslOCSP">OCSP Stapling</a></header><p>
<a href="#enableStapling">Enable OCSP Stapling</a> | <a href="#ocspRespMaxAge">OCSP Response Max Age (secs)</a> | <a href="#ocspResponder">OCSP Responder</a> | <a href="#ocspCACerts">OCSP CA Certificates</a></p></section>
<section class="toc-row"><header>Client Verification</header><p>
<a href="#clientVerify">Client Verification</a> | <a href="#verifyDepth">Verify Depth</a> | <a href="#crlPath">Client Revocation Path</a> | <a href="#crlFile">Client Revocation File</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="sslCert"><h3>SSL Private Key & Certificate<span class="ls-permlink"><a href="#sslCert"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Every SSL listener requires a paired SSL private key and SSL certificate. Multiple SSL listeners can share the same key and certificate.<br/><br/> You can generate SSL private keys yourself using an SSL software package, such as OpenSSL. SSL certificates can also be purchased from an authorized certificate issuer like VeriSign or Thawte. You can also sign the certificate yourself. Self-signed certificates will not be trusted by web browsers and should not be used on public websites containing critical data. However, a self-signed certificate is good enough for internal use, e.g. for encrypting traffic to LiteSpeed Web Server's WebAdmin Console.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="keyFile"><h3>Private Key File<span class="ls-permlink"><a href="#keyFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The filename of the SSL private key file. The key file should not be encrypted.</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 title="Security" class="ls-icon-security"></span> The private key file should be placed in a secured directory that allows read-only access to the user the server runs as.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="certFile"><h3>Certificate File<span class="ls-permlink"><a href="#certFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The filename of the SSL certificate file.</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 title="Security" class="ls-icon-security"></span> The certificate file should be placed in a secured directory, which allows read-only access to the user that the server runs as.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="certChain"><h3>Chained Certificate<span class="ls-permlink"><a href="#certChain"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether the certificate is a chained certificate or not. The file that stores a certificate chain must be in PEM format, and the certificates must be in the chained order, from the lowest level (the actual client or server certificate) to the highest level (root) CA.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="CACertPath"><h3>CA Certificate Path<span class="ls-permlink"><a href="#CACertPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the directory where the certificates of certification authorities (CAs) are kept. Those certificates are used for client certificate authentication and constructing the server certificate chain, which will be sent to browsers in addition to the server certificate.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="CACertFile"><h3>CA Certificate File<span class="ls-permlink"><a href="#CACertFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the file that contains all certificates of certification authorities (CAs) for chained certificates. This file is simply the concatenation of PEM-encoded certificate files, in order of preference. This can be used as an alternative or in addition to <span class="tagl"><a href="#CACertPath">CA Certificate Path</a></span>. Those certificates are used for client certificate authentication and constructing the server certificate chain, which will be sent to browsers in addition to the server certificate.</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"><div><header id="ciphers"><h3>Ciphers<span class="ls-permlink"><a href="#ciphers"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the cipher suite to be used when negotiating the SSL handshake. LSWS supports cipher suites implemented in SSL v3.0, TLS v1.0, TLS v1.2, and TLS v1.3.</p> <h4>Syntax</h4><p>Colon-separated string of cipher specifications.</p> <h4>Example</h4><div class="ls-example">ECDHE-RSA-AES128-SHA256:RC4:HIGH:!MD5:!aNULL:!EDH</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> We recommend leaving this field blank to use our default cipher which follows SSL cipher best practices.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableECDHE"><h3>Enable ECDH Key Exchange<span class="ls-permlink"><a href="#enableECDHE"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows use of Elliptic Curve Diffie-Hellman key exchange for further SSL encryption.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> ECDH key exchange is more secure than using just an RSA key. ECDH and DH key exchange are equally secure.<br/><br/> <span title="Performance" class="ls-icon-performance"></span> Enabling ECDH key exchange will increase CPU load and is slower than using just an RSA key.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableDHE"><h3>Enable DH Key Exchange<span class="ls-permlink"><a href="#enableDHE"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows use of Diffie-Hellman key exchange for further SSL encryption.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> DH key exchange is more secure than using just an RSA key. ECDH and DH key exchange are equally secure.<br/><br/> <span title="Performance" class="ls-icon-performance"></span> Enabling DH key exchange will increase CPU load and is slower than ECDH key exchange and RSA. ECDH key exchange is preferred when available.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="DHParam"><h3>DH Parameter<span class="ls-permlink"><a href="#DHParam"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the Diffie-Hellman parameter file necessary for DH key exchange.</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"><div><header id="renegProtection"><h3>SSL Renegotiation Protection<span class="ls-permlink"><a href="#renegProtection"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable SSL Renegotiation Protection to defend against SSL handshake-based attacks. The default value is "Yes".</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting can be enabled at the listener and virtual host levels.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionCache"><h3>Enable Session Cache<span class="ls-permlink"><a href="#sslSessionCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables session id caching using OpenSSL's default setting. Default value is "No".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionTickets"><h3>Enable Session Tickets<span class="ls-permlink"><a href="#sslSessionTickets"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables session tickets using OpenSSL's default session ticket setting. Server-level setting must be set to "Yes" for Virtual Host setting to take effect.<br/><br/> Default values:<br/> <b>Server-level:</b> Yes<br/> <b>VH-Level:</b> Yes</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableSpdy"><h3>ALPN<span class="ls-permlink"><a href="#enableSpdy"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Selectively enable HTTP/3, HTTP/2, and SPDY HTTP network protocols.<br/><br/> If you wish to disable SPDY, HTTP/2, and HTTP3, check "None" and leave all other boxes unchecked.<br/><br/> Default value: All enabled</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting can be set at the listener and virtual host levels.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="vhEnableQuic"><h3>Enable HTTP3/QUIC<span class="ls-permlink"><a href="#vhEnableQuic"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables the HTTP3/QUIC network protocol for this virtual host. For this setting to take effect, both <span class="tagl"><a href="ServTuning_Help.html#quicEnable">Enable HTTP3/QUIC</a></span> and <span class="tagl"><a href="Listeners_SSL_Help.html#allowQuic">Open HTTP3/QUIC (UDP) port</a></span> must also be set to <span class="val">Yes</span> at the server and listener levels respectively. Default value is <span class="val">Yes</span>.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> When this setting is set to <span class="val">No</span>, the HTTP3/QUIC advertisement will no longer be sent. If a browser still contains cached HTTP3/QUIC information and HTTP3/QUIC is still enabled at the server and listener levels, an HTTP3/QUIC connection will continue to be used until this information is no longer cached or an HTTP3/QUIC protocol error is encountered.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslOCSP"><h3>OCSP Stapling<span class="ls-permlink"><a href="#sslOCSP"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Online Certificate Status Protocol (OCSP) is a more efficient method of checking whether a digital certificate is valid. It works by communicating with another server — the OCSP responder — to get verification that the certificate is valid instead of checking through certificate revocation lists (CRL).<br/><br/> OCSP stapling is a further improvement on this protocol, allowing the server to check with the OCSP responder at regular intervals instead of every time a certificate is requested. See the <a href="http://en.wikipedia.org/wiki/OCSP_Stapling" target="_blank" rel="noopener noreferrer">OCSP Wikipedia page</a> for more details.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableStapling"><h3>Enable OCSP Stapling<span class="ls-permlink"><a href="#enableStapling"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Determines whether to enable OCSP stapling, a more efficient way of verifying public key certificates.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ocspRespMaxAge"><h3>OCSP Response Max Age (secs)<span class="ls-permlink"><a href="#ocspRespMaxAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>This option sets the maximum allowable age for an OCSP response. If an OCSP response is older than this maximum age, the server will contact the OCSP responder for a new response. The default value is <span class="val">86400</span>. Maximum age can be turned off by setting this value to <span class="val">-1</span>.</p> <h4>Syntax</h4><p>Integer of seconds</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ocspResponder"><h3>OCSP Responder<span class="ls-permlink"><a href="#ocspResponder"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the URL of the OCSP responder to be used. If not set, the server will attempt to contact the OCSP responder detailed in the certificate authority's issuer certificate. Some issuer certificates may not have an OCSP responder URL specified.</p> <h4>Syntax</h4><p>URL starting with <span class="val">http://</span></p> <h4>Example</h4><div class="ls-example"><span class="val">http://rapidssl-ocsp.geotrust.com </span></div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ocspCACerts"><h3>OCSP CA Certificates<span class="ls-permlink"><a href="#ocspCACerts"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the file where OCSP certificate authority (CA) certificates are stored. These certificates are used to check responses from the OCSP responder (and make sure those responses are not spoofed or otherwise compromised). This file should contain the whole certificate chain. If this file does not contain the root certificate, LSWS should be able to find the root certificate in your system directory without you adding it to the file, but, if this validation fails, you should try adding your root certificate to this file.<br/><br/> This setting is optional. If this setting is not set, the server will automatically check <span class="tagl"><a href="#CACertFile">CA Certificate File</a></span>.</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"><div><header id="clientVerify"><h3>Client Verification<span class="ls-permlink"><a href="#clientVerify"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the type of client certifcate authentication. Available types are: <ul> <li><b>None:</b> No client certificate is required.</li> <li><b>Optional:</b> Client certificate is optional.</li> <li><b>Require:</b> The client must has valid certificate.</li> <li><b>Optional_no_ca:</b> Same as optional.</li> </ul> The default is "None".</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> "None" or "Require" are recommended.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="verifyDepth"><h3>Verify Depth<span class="ls-permlink"><a href="#verifyDepth"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies how deeply a certificate should be verified before determining that the client does not have a valid certificate. The default is "1".</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="crlPath"><h3>Client Revocation Path<span class="ls-permlink"><a href="#crlPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the directory containing PEM-encoded CA CRL files for revoked client certificates. The files in this directory have to be PEM-encoded. These files are accessed through hash filenames, hash-value.rN. Please refer to openSSL or Apache mod_ssl documentation regarding creating the hash filename.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="crlFile"><h3>Client Revocation File<span class="ls-permlink"><a href="#crlFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the file containing PEM-encoded CA CRL files enumerating revoked client certificates. This can be used as an alternative or in addition to <span class="tagl"><a href="#crlPath">Client Revocation Path</a></span>.</p> <h4>Syntax</h4><p>Filename which can be an absolute path or a relative path to $SERVER_ROOT.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Java_Web_App_Context.html 0000644 00000077406 15055121352 0011431 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Java Web App Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Java Web App Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<ul class="level3">
<li><a href="Static_Context.html">Static Context</a></li>
<li>
<span class="current"><a href="Java_Web_App_Context.html">Java Web App Context</a></span>
</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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Static_Context.html">Static Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="Servlet_Context.html">Servlet Context</a> »</div></div>
<h1>Java Web App Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#javaWebAppContext">Java Web App Context</a></header><p>
<a href="#uri">URI</a> | <a href="#javaWebApp_location">Location</a> | <a href="#javaServletEngine">Servlet Engine</a> | <a href="#enableExpires">Enable Expires</a> | <a href="#expiresDefault">Expires Default</a> | <a href="#expiresByType">Expires By Type</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#autoIndex">Auto Index</a> | <a href="#indexFiles">Index Files</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="javaWebAppContext"><h3>Java Web App Context<span class="ls-permlink"><a href="#javaWebAppContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Many people running Java applications use the servlet engine to serve static content as well. But no servlet engine is nearly as efficient as LiteSpeed Web Server for these processes. In order to improve the overall performance, LiteSpeed Web Server can be configured as a gateway server, which serves static content and forwards dynamic Java page requests to the servlet engine.<br/><br/> LiteSpeed Web Server requires certain contexts to be defined in order to run a Java application. A Java Web App Context automatically creates all required contexts based on the Java web application's configuration file (WEB-INF/web.xml).<br/><br/> There are a few points you need to keep in mind when setting up a Java Web App Context:<br/> <ul> <li>A <span class="val">Servlet Engine</span> external application must be set up in <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> before Java Web App Context can be set up.<li> <li>A <span class="tagP"><a href="#ScriptHandler_Help">Script Handler</a></span> for .jsp files should be defined as well.</li> <li>If the web application is packed into a .war file, the .war file must be expanded. The server cannot access compressed archive files.</li> <li>For the same resources, the same URL should be used no matter whether it is accessed through LiteSpeed Web Server or through the servlet engine's built-in HTTP server.<br/><br/> For example, Tomcat 4.1 is installed under /opt/tomcat. Files for the "examples" web application are located at /opt/tomcat/webapps/examples/. Through Tomcat's built-in HTTP server, the "examples" web application is thus accessed with a URI like "/examples/***". The corresponding Java Web App Context should thus be configured: <span class="tagl"><a href="#expuri">URI</a></span> = <span class="val">/examples/</span>, <span class="tagl"><a href="#location">Location</a></span> = <span class="val">/opt/tomcat/webapps/examples/</span>.</li> </ul></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="uri"><h3>URI<span class="ls-permlink"><a href="#uri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the URI for this context. The URI should start with a "/". If a URI ends with a "/", then this context will include all sub-URIs under this URI.</p> <h4>Syntax</h4><p>URI</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="javaWebApp_location"><h3>Location<span class="ls-permlink"><a href="#javaWebApp_location"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the directory that contains the files for this web application. This is the directory containing "WEB-INF/web.xml".<br/><br/> Default value: $DOC_ROOT + <span class="tagl"><a href="#uri">URI</a></span></p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="javaServletEngine"><h3>Servlet Engine<span class="ls-permlink"><a href="#javaServletEngine"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of the servlet engine that serves this web application. Servlet engines must be defined in the <span class="tagP"><a href="#ExtApp_Help">External Apps</a></span> section at the server or virtual host level.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableExpires"><h3>Enable Expires<span class="ls-permlink"><a href="#enableExpires"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresDefault"><h3>Expires Default<span class="ls-permlink"><a href="#expiresDefault"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresByType"><h3>Expires By Type<span class="ls-permlink"><a href="#expiresByType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoIndex"><h3>Auto Index<span class="ls-permlink"><a href="#autoIndex"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Security" class="ls-icon-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"><div><header id="indexFiles"><h3>Index Files<span class="ls-permlink"><a href="#indexFiles"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Only set index files that you need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Rails_Context.html 0000644 00000111736 15055121352 0010220 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Rack/Rails Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Rack/Rails Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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><span class="current"><a href="Rails_Context.html">Rack/Rails Context</a></span></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="App_Server_Context.html">App Server Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"> </div></div>
<h1>Rack/Rails Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#railsContext">Rack/Rails Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#rails_location">Location</a> | <a href="#railsEnv">Run-Time Mode</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#enableExpires">Enable Expires</a> | <a href="#expiresDefault">Expires Default</a> | <a href="#expiresByType">Expires By Type</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#indexFiles">Index Files</a> | <a href="#autoIndex">Auto Index</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#enableRewrite">Enable Rewrite</a> | <a href="#rewriteInherit">Rewrite Inherit</a> | <a href="#rewriteBase">Rewrite Base</a> | <a href="#rewriteRules">Rewrite Rules</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="railsContext"><h3>Rack/Rails Context<span class="ls-permlink"><a href="#railsContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A Rack/Rails Context provides an easy way to configure a Ruby Rack/Rails application. To add a Rack/Rails application through a Rack/Rails Context, only mounting the URL and the application's root directory is required. There is no need to go through all the troubles to define an external application, add a 404 handler, and rewrite rules, etc.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rails_location"><h3>Location<span class="ls-permlink"><a href="#rails_location"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the corresponding location of this context in the file system.<br/><br/> Default value: $DOC_ROOT + <span class="tagl"><a href="#expuri">URI</a></span></p> <h4>Syntax</h4><p>It can be an absolute path or path relative to $SERVER_ROOT, $VH_ROOT, or $DOC_ROOT. $DOC_ROOT is the default relative path, and can be omitted.<br/><br/> If the <span class="tagl"><a href="#expuri">URI</a></span> is a regular expression, then the matched sub-string can be used to form the "Root" string. The matched sub-string can be referenced with the values "$1" - "$9". "$0" and "&" can be used to reference the whole matched string. Additionally, a query string can be set by appending a "?" followed by the query string. Be careful. "&" should be escaped as "\&" in the query string.</p> <h4>Example</h4><div class="ls-example">A plain URI like <span class="val">/examples/</span> with <span class="tagl"><a href="#location">Location</a></span> set to <span class="val">/home/john/web_examples</span> will map the request "/examples/foo/bar.html" to file "/home/john/web_examples/foo/bar.html".<br/> To simulate Apache's mod_userdir, set URI to <span class="val">exp: ^/~([A-Za-z0-9]+)(.*)</span>, set <span class="tagl"><a href="#location">Location</a></span> to <span class="val">/home/$1/public_html$2</span>. With these settings, a request of URI /~john/foo/bar.html will map to file /home/john/public_html/foo/bar.html.</div><h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#expuri">URI</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="railsEnv"><h3>Run-Time Mode<span class="ls-permlink"><a href="#railsEnv"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which mode Rack/Rails will be running as: "Development", "Production", or "Staging". The default is "Production".</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableExpires"><h3>Enable Expires<span class="ls-permlink"><a href="#enableExpires"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresDefault"><h3>Expires Default<span class="ls-permlink"><a href="#expiresDefault"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="expiresByType"><h3>Expires By Type<span class="ls-permlink"><a href="#expiresByType"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="indexFiles"><h3>Index Files<span class="ls-permlink"><a href="#indexFiles"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Performance" class="ls-icon-performance"></span> Only set index files that you need.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="autoIndex"><h3>Auto Index<span class="ls-permlink"><a href="#autoIndex"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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 title="Security" class="ls-icon-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"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableRewrite"><h3>Enable Rewrite<span class="ls-permlink"><a href="#enableRewrite"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable LiteSpeed's URL rewrite engine. This option can be customized at the virtual host or context level, and is inherited along the directory tree until it is explicitly overridden.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteInherit"><h3>Rewrite Inherit<span class="ls-permlink"><a href="#rewriteInherit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to inherit rewrite rules from parent contexts. If rewrite is enabled and not inherited, rewrite base and rewrite rules defined in this context will be used.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteBase"><h3>Rewrite Base<span class="ls-permlink"><a href="#rewriteBase"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the base URL for rewrite rules.</p> <h4>Syntax</h4><p>URL</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteRules"><h3>Rewrite Rules<span class="ls-permlink"><a href="#rewriteRules"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a list of rewrite rules at the virtual host level.<br/><br/> Do NOT add any document root level rewrite rules here. If you have any document root level rewrite rules from .htaccess, you should instead create a static context with uri "/" and add the rewrite rules there.<br/><br/> A rewrite rule is comprised of one <span class="val">RewriteRule</span> directive and optionally preceded by multiple <span class="val">RewriteCond</span> directives. <ul> <li>Each directive should take only one line.</li> <li> <span class="val">RewriteCond</span> and <span class="val">RewriteRule</span> follow Apache's rewrite directive syntax. Just copy and paste rewrite directives from your Apache configuration files. </li> <li> There are minor differences between LiteSpeed and Apache mod_rewrite implementation: <ul> <li> <span class="val">%\{LA-U:variable\}</span> and <span class="val">%\{LA-F:variable\}</span> are ignored by the LiteSpeed rewrite engine </li> <li> Two new server variables are added in the LiteSpeed rewrite engine: <span class="val">%\{CURRENT_URI\}</span> represents the current URI being processed by the rewrite engine and <span class="val">%\{SCRIPT_NAME\}</span> has the same meaning as the corresponding CGI environment variable. </li> <li> The LiteSpeed rewrite engine will stop processing rewrite rules after encountering an <span class="val">[L]</span> flag to avoid looping while Apache mod_rewrite will stop processing rewrite rules for the current iteration only. This behavior is similar to that of the <span class="val">[END]</span> flag in Apache mod_rewrite. </li> </ul> </li> </ul><br/> The implementation of LiteSpeed's rewrite engine follows Apache's rewrite engine specifications. For more details about rewrite rules, please refer to <a href="https://httpd.apache.org/docs/current/mod/mod_rewrite.html" target="_blank" rel="noopener noreferrer"> Apache's mod_rewrite document </a> and <a href="https://httpd.apache.org/docs/current/rewrite/" target="_blank" rel="noopener noreferrer"> Apache's URL rewriting guide </a>.</p> <h4>Syntax</h4><p>string</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Redirect_Context.html 0000644 00000043063 15055121352 0010704 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Redirect Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Redirect Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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><span class="current"><a href="Redirect_Context.html">Redirect Context</a></span></li>
<li><a href="App_Server_Context.html">App Server Context</a></li>
<li><a href="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="LB_Context.html">Load Balancer Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="App_Server_Context.html">App Server Context</a> »</div></div>
<h1>Redirect Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#redirectContext">Redirect Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#externalredirect">External Redirect</a> | <a href="#statuscode">Status Code</a> | <a href="#destinationuri">Destination URI</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="redirectContext"><h3>Redirect Context<span class="ls-permlink"><a href="#redirectContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A Redirect Context can be used to forward one URI or a group of URIs to another location. The destination URI can be either on the same web site (an internal redirect) or an absolute URI pointing to another web site (an external redirect).</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="externalredirect"><h3>External Redirect<span class="ls-permlink"><a href="#externalredirect"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether this redirect is external. For external redirection, <span class="tagl"><a href="#statuscode">Status Code</a></span> may be specified and <span class="tagl"><a href="#destinationuri">Destination URI</a></span> can start either with "/" or "http(s)://". For internal redirection, <span class="tagl"><a href="#destinationuri">Destination URI</a></span> must start with "/".</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="statuscode"><h3>Status Code<span class="ls-permlink"><a href="#statuscode"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the response status code of the external redirection. If the status code is between 300 and 399, <span class="tagl"><a href="#destinationuri">Destination URI</a></span> can be specified.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="destinationuri"><h3>Destination URI<span class="ls-permlink"><a href="#destinationuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the target location of the redirect. If this redirected URI maps to a URI in another redirect context, it will be redirected again.</p> <h4>Syntax</h4><p>This URI can either be a relative URI on the same web site starting with "/", or an absolute URI pointing to different web site starting with "http(s)://". If the <span class="tagl"><a href="#expuri">URI</a></span> contains regular expressions, the destination can reference the matched variables, such as $1 or $2.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
AdminListeners_SSL_Help.html 0000644 00000047745 15055121352 0012064 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Admin Listeners SSL</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Admin Listeners SSL." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
<span class="current"><a href="AdminListeners_SSL_Help.html">Admin Listener SSL</a></span>
</li>
</ul>
</li>
</ul>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="AdminListeners_General_Help.html">Admin Listeners General</a></div><div class="center"><a href="webconsole.html">Web Console</a></div><div class="next"> </div></div>
<h1>Admin Listeners SSL</h1><section class="ls-spacer-small-bottom">Admin Listeners are dedicated to the Admin Server. Secure (SSL) listeners
are recommended for the Admin Server.</section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#sslCert">SSL Private Key & Certificate</a></header><p>
<a href="#keyFile">Private Key File</a> | <a href="#certFile">Certificate File</a> | <a href="#certChain">Chained Certificate</a> | <a href="#CACertPath">CA Certificate Path</a> | <a href="#CACertFile">CA Certificate File</a></p></section>
<section class="toc-row"><header>SSL Protocol</header><p>
<a href="#sslProtocol">Protocol Version</a> | <a href="#ciphers">Ciphers</a> | <a href="#enableECDHE">Enable ECDH Key Exchange</a> | <a href="#enableDHE">Enable DH Key Exchange</a> | <a href="#DHParam">DH Parameter</a></p></section>
<section class="toc-row"><header>Security & Features</header><p>
<a href="#renegProtection">SSL Renegotiation Protection</a> | <a href="#sslSessionCache">Enable Session Cache</a> | <a href="#sslSessionTickets">Enable Session Tickets</a> | <a href="#enableSpdy">ALPN</a> | <a href="#allowQuic">Open HTTP3/QUIC (UDP) port</a></p></section>
<section class="toc-row"><header>Client Verification</header><p>
<a href="#clientVerify">Client Verification</a> | <a href="#verifyDepth">Verify Depth</a> | <a href="#crlPath">Client Revocation Path</a> | <a href="#crlFile">Client Revocation File</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="sslCert"><h3>SSL Private Key & Certificate<span class="ls-permlink"><a href="#sslCert"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Every SSL listener requires a paired SSL private key and SSL certificate. Multiple SSL listeners can share the same key and certificate.<br/><br/> You can generate SSL private keys yourself using an SSL software package, such as OpenSSL. SSL certificates can also be purchased from an authorized certificate issuer like VeriSign or Thawte. You can also sign the certificate yourself. Self-signed certificates will not be trusted by web browsers and should not be used on public websites containing critical data. However, a self-signed certificate is good enough for internal use, e.g. for encrypting traffic to LiteSpeed Web Server's WebAdmin Console.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="keyFile"><h3>Private Key File<span class="ls-permlink"><a href="#keyFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The filename of the SSL private key file. The key file should not be encrypted.</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 title="Security" class="ls-icon-security"></span> The private key file should be placed in a secured directory that allows read-only access to the user the server runs as.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="certFile"><h3>Certificate File<span class="ls-permlink"><a href="#certFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The filename of the SSL certificate file.</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 title="Security" class="ls-icon-security"></span> The certificate file should be placed in a secured directory, which allows read-only access to the user that the server runs as.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="certChain"><h3>Chained Certificate<span class="ls-permlink"><a href="#certChain"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether the certificate is a chained certificate or not. The file that stores a certificate chain must be in PEM format, and the certificates must be in the chained order, from the lowest level (the actual client or server certificate) to the highest level (root) CA.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="CACertPath"><h3>CA Certificate Path<span class="ls-permlink"><a href="#CACertPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the directory where the certificates of certification authorities (CAs) are kept. Those certificates are used for client certificate authentication and constructing the server certificate chain, which will be sent to browsers in addition to the server certificate.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="CACertFile"><h3>CA Certificate File<span class="ls-permlink"><a href="#CACertFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the file that contains all certificates of certification authorities (CAs) for chained certificates. This file is simply the concatenation of PEM-encoded certificate files, in order of preference. This can be used as an alternative or in addition to <span class="tagl"><a href="#CACertPath">CA Certificate Path</a></span>. Those certificates are used for client certificate authentication and constructing the server certificate chain, which will be sent to browsers in addition to the server certificate.</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"><div><header id="sslProtocol"><h3>Protocol Version<span class="ls-permlink"><a href="#sslProtocol"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A selection of SSL protocols accepted by the listener.<br/><br/> Options include: <span class="val">SSL v3.0</span>, <span class="val">TLS v1.0</span>, <span class="val">TLS v1.1</span>, <span class="val">TLS v1.2</span>, <span class="val">TLS v1.3</span>.</p> <h4>Syntax</h4><p>Select from checkbox</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ciphers"><h3>Ciphers<span class="ls-permlink"><a href="#ciphers"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the cipher suite to be used when negotiating the SSL handshake. LSWS supports cipher suites implemented in SSL v3.0, TLS v1.0, TLS v1.2, and TLS v1.3.</p> <h4>Syntax</h4><p>Colon-separated string of cipher specifications.</p> <h4>Example</h4><div class="ls-example">ECDHE-RSA-AES128-SHA256:RC4:HIGH:!MD5:!aNULL:!EDH</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> We recommend leaving this field blank to use our default cipher which follows SSL cipher best practices.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableECDHE"><h3>Enable ECDH Key Exchange<span class="ls-permlink"><a href="#enableECDHE"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows use of Elliptic Curve Diffie-Hellman key exchange for further SSL encryption.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> ECDH key exchange is more secure than using just an RSA key. ECDH and DH key exchange are equally secure.<br/><br/> <span title="Performance" class="ls-icon-performance"></span> Enabling ECDH key exchange will increase CPU load and is slower than using just an RSA key.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableDHE"><h3>Enable DH Key Exchange<span class="ls-permlink"><a href="#enableDHE"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows use of Diffie-Hellman key exchange for further SSL encryption.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> DH key exchange is more secure than using just an RSA key. ECDH and DH key exchange are equally secure.<br/><br/> <span title="Performance" class="ls-icon-performance"></span> Enabling DH key exchange will increase CPU load and is slower than ECDH key exchange and RSA. ECDH key exchange is preferred when available.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="DHParam"><h3>DH Parameter<span class="ls-permlink"><a href="#DHParam"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the Diffie-Hellman parameter file necessary for DH key exchange.</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"><div><header id="renegProtection"><h3>SSL Renegotiation Protection<span class="ls-permlink"><a href="#renegProtection"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable SSL Renegotiation Protection to defend against SSL handshake-based attacks. The default value is "Yes".</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting can be enabled at the listener and virtual host levels.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionCache"><h3>Enable Session Cache<span class="ls-permlink"><a href="#sslSessionCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables session id caching using OpenSSL's default setting. Default value is "No".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionTickets"><h3>Enable Session Tickets<span class="ls-permlink"><a href="#sslSessionTickets"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables session tickets using OpenSSL's default session ticket setting. Server-level setting must be set to "Yes" for Virtual Host setting to take effect.<br/><br/> Default values:<br/> <b>Server-level:</b> Yes<br/> <b>VH-Level:</b> Yes</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableSpdy"><h3>ALPN<span class="ls-permlink"><a href="#enableSpdy"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Selectively enable HTTP/3, HTTP/2, and SPDY HTTP network protocols.<br/><br/> If you wish to disable SPDY, HTTP/2, and HTTP3, check "None" and leave all other boxes unchecked.<br/><br/> Default value: All enabled</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting can be set at the listener and virtual host levels.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowQuic"><h3>Open HTTP3/QUIC (UDP) port<span class="ls-permlink"><a href="#allowQuic"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows the use of the HTTP3/QUIC network protocol for virtual hosts mapped to this listener. For this setting to take effect, <span class="tagl"><a href="ServTuning_Help.html#quicEnable">Enable HTTP3/QUIC</a></span> must also be set to <span class="val">Yes</span> at the server level. Default value is <span class="val">Yes</span>.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> When this setting is set to <span class="val">Yes</span>, HTTP3/QUIC can still be disabled at the virtual host level through the <span class="tagl"><a href="VHSSL_Help.html#vhEnableQuic">Enable HTTP3/QUIC</a></span> setting.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="clientVerify"><h3>Client Verification<span class="ls-permlink"><a href="#clientVerify"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the type of client certifcate authentication. Available types are: <ul> <li><b>None:</b> No client certificate is required.</li> <li><b>Optional:</b> Client certificate is optional.</li> <li><b>Require:</b> The client must has valid certificate.</li> <li><b>Optional_no_ca:</b> Same as optional.</li> </ul> The default is "None".</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> "None" or "Require" are recommended.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="verifyDepth"><h3>Verify Depth<span class="ls-permlink"><a href="#verifyDepth"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies how deeply a certificate should be verified before determining that the client does not have a valid certificate. The default is "1".</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="crlPath"><h3>Client Revocation Path<span class="ls-permlink"><a href="#crlPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the directory containing PEM-encoded CA CRL files for revoked client certificates. The files in this directory have to be PEM-encoded. These files are accessed through hash filenames, hash-value.rN. Please refer to openSSL or Apache mod_ssl documentation regarding creating the hash filename.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="crlFile"><h3>Client Revocation File<span class="ls-permlink"><a href="#crlFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the file containing PEM-encoded CA CRL files enumerating revoked client certificates. This can be used as an alternative or in addition to <span class="tagl"><a href="#crlPath">Client Revocation Path</a></span>.</p> <h4>Syntax</h4><p>Filename which can be an absolute path or a relative path to $SERVER_ROOT.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
AdminListeners_General_Help.html 0000644 00000020603 15055121352 0012760 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Admin Listeners General</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Admin Listeners General." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
<span class="current"><a href="AdminListeners_General_Help.html">
Admin Listener General
</a></span>
</li>
<li>
<a href="AdminListeners_SSL_Help.html">Admin Listener SSL</a>
</li>
</ul>
</li>
</ul>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="AdminSecurity_Help.html">Admin Console Security</a></div><div class="center"><a href="webconsole.html">Web Console</a></div><div class="next"><a href="AdminListeners_SSL_Help.html">Admin Listeners SSL</a> »</div></div>
<h1>Admin Listeners General</h1><section class="ls-spacer-small-bottom">Admin Listeners are dedicated to the Admin Server. Secure (SSL) listeners
are recommended for the Admin Server.</section>
<h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>General</header><p>
<a href="#listenerName">Listener Name</a> | <a href="#listenerIP">IP Address</a> | <a href="#listenerPort">Port</a> | <a href="#listenerSecure">Secure</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="listenerName"><h3>Listener Name<span class="ls-permlink"><a href="#listenerName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this listener.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerIP"><h3>IP Address<span class="ls-permlink"><a href="#listenerIP"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the IP of this listener. All available IP addresses are listed. IPv6 addresses are enclosed in "[ ]".<br/><br/> To listen on all IPv4 IP addresses, select <span class="val">ANY</span>. To listen on all IPv6 IP addresses, select <span class="val">[ANY] IPv6</span>. If <span class="val">No</span> is selected for setting <span class="tagl"><a href="#bindIPv6Only">Bind IPv6 Only</a></span>, selecting <span class="val">[ANY] IPv6</span> will listen on IPv4 addresses as well.<br/><br/> By default, LiteSpeed uses separate listeners for IPv4 and IPv6 addresses. Should the need to serve both IPv4 and IPv6 arise, separate listeners should be created for each.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If your machine has multiple IPs on different sub-networks, you can select a specific IP to only allow traffic from the corresponding sub-network.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerPort"><h3>Port<span class="ls-permlink"><a href="#listenerPort"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the TCP port of the listener. Only the super user ("root") can use ports lower than <span class="val">1024</span>. Port <span class="val">80</span> is the default HTTP port. Port <span class="val">443</span> is the default HTTPS port.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerSecure"><h3>Secure<span class="ls-permlink"><a href="#listenerSecure"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether this is a secure (SSL) listener. For secure listeners, additional SSL settings need to be set properly.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
Listeners_SSL_Help.html 0000644 00000057547 15055121352 0011114 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Listeners SSL</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Listeners SSL." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</a></li>
<li><a href="Listeners_General_Help.html">Listener General</a></li>
<li><span class="current"><a href="Listeners_SSL_Help.html">Listener SSL</a></span></li>
<li><a href="Templates_Help.html">Virtual Host Templates</a></li>
<li><a href="VirtualHosts_Help.html">Virtual Host Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Listeners_General_Help.html">Listeners General</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="Templates_Help.html">Virtual Host Templates</a> »</div></div>
<h1>Listeners SSL</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#sslCert">SSL Private Key & Certificate</a></header><p>
<a href="#keyFile">Private Key File</a> | <a href="#certFile">Certificate File</a> | <a href="#certChain">Chained Certificate</a> | <a href="#CACertPath">CA Certificate Path</a> | <a href="#CACertFile">CA Certificate File</a></p></section>
<section class="toc-row"><header>SSL Protocol</header><p>
<a href="#sslProtocol">Protocol Version</a> | <a href="#ciphers">Ciphers</a> | <a href="#enableECDHE">Enable ECDH Key Exchange</a> | <a href="#enableDHE">Enable DH Key Exchange</a> | <a href="#DHParam">DH Parameter</a></p></section>
<section class="toc-row"><header>Security & Features</header><p>
<a href="#renegProtection">SSL Renegotiation Protection</a> | <a href="#sslSessionCache">Enable Session Cache</a> | <a href="#sslSessionTickets">Enable Session Tickets</a> | <a href="#enableSpdy">ALPN</a> | <a href="#allowQuic">Open HTTP3/QUIC (UDP) port</a></p></section>
<section class="toc-row"><header><a href="#sslOCSP">OCSP Stapling</a></header><p>
<a href="#enableStapling">Enable OCSP Stapling</a> | <a href="#ocspRespMaxAge">OCSP Response Max Age (secs)</a> | <a href="#ocspResponder">OCSP Responder</a> | <a href="#ocspCACerts">OCSP CA Certificates</a></p></section>
<section class="toc-row"><header>Client Verification</header><p>
<a href="#clientVerify">Client Verification</a> | <a href="#verifyDepth">Verify Depth</a> | <a href="#crlPath">Client Revocation Path</a> | <a href="#crlFile">Client Revocation File</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="sslCert"><h3>SSL Private Key & Certificate<span class="ls-permlink"><a href="#sslCert"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Every SSL listener requires a paired SSL private key and SSL certificate. Multiple SSL listeners can share the same key and certificate.<br/><br/> You can generate SSL private keys yourself using an SSL software package, such as OpenSSL. SSL certificates can also be purchased from an authorized certificate issuer like VeriSign or Thawte. You can also sign the certificate yourself. Self-signed certificates will not be trusted by web browsers and should not be used on public websites containing critical data. However, a self-signed certificate is good enough for internal use, e.g. for encrypting traffic to LiteSpeed Web Server's WebAdmin Console.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="keyFile"><h3>Private Key File<span class="ls-permlink"><a href="#keyFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The filename of the SSL private key file. The key file should not be encrypted.</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 title="Security" class="ls-icon-security"></span> The private key file should be placed in a secured directory that allows read-only access to the user the server runs as.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="certFile"><h3>Certificate File<span class="ls-permlink"><a href="#certFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The filename of the SSL certificate file.</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 title="Security" class="ls-icon-security"></span> The certificate file should be placed in a secured directory, which allows read-only access to the user that the server runs as.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="certChain"><h3>Chained Certificate<span class="ls-permlink"><a href="#certChain"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether the certificate is a chained certificate or not. The file that stores a certificate chain must be in PEM format, and the certificates must be in the chained order, from the lowest level (the actual client or server certificate) to the highest level (root) CA.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="CACertPath"><h3>CA Certificate Path<span class="ls-permlink"><a href="#CACertPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the directory where the certificates of certification authorities (CAs) are kept. Those certificates are used for client certificate authentication and constructing the server certificate chain, which will be sent to browsers in addition to the server certificate.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="CACertFile"><h3>CA Certificate File<span class="ls-permlink"><a href="#CACertFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the file that contains all certificates of certification authorities (CAs) for chained certificates. This file is simply the concatenation of PEM-encoded certificate files, in order of preference. This can be used as an alternative or in addition to <span class="tagl"><a href="#CACertPath">CA Certificate Path</a></span>. Those certificates are used for client certificate authentication and constructing the server certificate chain, which will be sent to browsers in addition to the server certificate.</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"><div><header id="sslProtocol"><h3>Protocol Version<span class="ls-permlink"><a href="#sslProtocol"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A selection of SSL protocols accepted by the listener.<br/><br/> Options include: <span class="val">SSL v3.0</span>, <span class="val">TLS v1.0</span>, <span class="val">TLS v1.1</span>, <span class="val">TLS v1.2</span>, <span class="val">TLS v1.3</span>.</p> <h4>Syntax</h4><p>Select from checkbox</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ciphers"><h3>Ciphers<span class="ls-permlink"><a href="#ciphers"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the cipher suite to be used when negotiating the SSL handshake. LSWS supports cipher suites implemented in SSL v3.0, TLS v1.0, TLS v1.2, and TLS v1.3.</p> <h4>Syntax</h4><p>Colon-separated string of cipher specifications.</p> <h4>Example</h4><div class="ls-example">ECDHE-RSA-AES128-SHA256:RC4:HIGH:!MD5:!aNULL:!EDH</div><h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> We recommend leaving this field blank to use our default cipher which follows SSL cipher best practices.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableECDHE"><h3>Enable ECDH Key Exchange<span class="ls-permlink"><a href="#enableECDHE"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows use of Elliptic Curve Diffie-Hellman key exchange for further SSL encryption.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> ECDH key exchange is more secure than using just an RSA key. ECDH and DH key exchange are equally secure.<br/><br/> <span title="Performance" class="ls-icon-performance"></span> Enabling ECDH key exchange will increase CPU load and is slower than using just an RSA key.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableDHE"><h3>Enable DH Key Exchange<span class="ls-permlink"><a href="#enableDHE"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows use of Diffie-Hellman key exchange for further SSL encryption.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> DH key exchange is more secure than using just an RSA key. ECDH and DH key exchange are equally secure.<br/><br/> <span title="Performance" class="ls-icon-performance"></span> Enabling DH key exchange will increase CPU load and is slower than ECDH key exchange and RSA. ECDH key exchange is preferred when available.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="DHParam"><h3>DH Parameter<span class="ls-permlink"><a href="#DHParam"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the Diffie-Hellman parameter file necessary for DH key exchange.</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"><div><header id="renegProtection"><h3>SSL Renegotiation Protection<span class="ls-permlink"><a href="#renegProtection"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable SSL Renegotiation Protection to defend against SSL handshake-based attacks. The default value is "Yes".</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting can be enabled at the listener and virtual host levels.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionCache"><h3>Enable Session Cache<span class="ls-permlink"><a href="#sslSessionCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables session id caching using OpenSSL's default setting. Default value is "No".</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslSessionTickets"><h3>Enable Session Tickets<span class="ls-permlink"><a href="#sslSessionTickets"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Enables session tickets using OpenSSL's default session ticket setting. Server-level setting must be set to "Yes" for Virtual Host setting to take effect.<br/><br/> Default values:<br/> <b>Server-level:</b> Yes<br/> <b>VH-Level:</b> Yes</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableSpdy"><h3>ALPN<span class="ls-permlink"><a href="#enableSpdy"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Selectively enable HTTP/3, HTTP/2, and SPDY HTTP network protocols.<br/><br/> If you wish to disable SPDY, HTTP/2, and HTTP3, check "None" and leave all other boxes unchecked.<br/><br/> Default value: All enabled</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This setting can be set at the listener and virtual host levels.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowQuic"><h3>Open HTTP3/QUIC (UDP) port<span class="ls-permlink"><a href="#allowQuic"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Allows the use of the HTTP3/QUIC network protocol for virtual hosts mapped to this listener. For this setting to take effect, <span class="tagl"><a href="ServTuning_Help.html#quicEnable">Enable HTTP3/QUIC</a></span> must also be set to <span class="val">Yes</span> at the server level. Default value is <span class="val">Yes</span>.</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> When this setting is set to <span class="val">Yes</span>, HTTP3/QUIC can still be disabled at the virtual host level through the <span class="tagl"><a href="VHSSL_Help.html#vhEnableQuic">Enable HTTP3/QUIC</a></span> setting.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="sslOCSP"><h3>OCSP Stapling<span class="ls-permlink"><a href="#sslOCSP"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Online Certificate Status Protocol (OCSP) is a more efficient method of checking whether a digital certificate is valid. It works by communicating with another server — the OCSP responder — to get verification that the certificate is valid instead of checking through certificate revocation lists (CRL).<br/><br/> OCSP stapling is a further improvement on this protocol, allowing the server to check with the OCSP responder at regular intervals instead of every time a certificate is requested. See the <a href="http://en.wikipedia.org/wiki/OCSP_Stapling" target="_blank" rel="noopener noreferrer">OCSP Wikipedia page</a> for more details.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableStapling"><h3>Enable OCSP Stapling<span class="ls-permlink"><a href="#enableStapling"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Determines whether to enable OCSP stapling, a more efficient way of verifying public key certificates.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ocspRespMaxAge"><h3>OCSP Response Max Age (secs)<span class="ls-permlink"><a href="#ocspRespMaxAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>This option sets the maximum allowable age for an OCSP response. If an OCSP response is older than this maximum age, the server will contact the OCSP responder for a new response. The default value is <span class="val">86400</span>. Maximum age can be turned off by setting this value to <span class="val">-1</span>.</p> <h4>Syntax</h4><p>Integer of seconds</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ocspResponder"><h3>OCSP Responder<span class="ls-permlink"><a href="#ocspResponder"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the URL of the OCSP responder to be used. If not set, the server will attempt to contact the OCSP responder detailed in the certificate authority's issuer certificate. Some issuer certificates may not have an OCSP responder URL specified.</p> <h4>Syntax</h4><p>URL starting with <span class="val">http://</span></p> <h4>Example</h4><div class="ls-example"><span class="val">http://rapidssl-ocsp.geotrust.com </span></div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="ocspCACerts"><h3>OCSP CA Certificates<span class="ls-permlink"><a href="#ocspCACerts"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of the file where OCSP certificate authority (CA) certificates are stored. These certificates are used to check responses from the OCSP responder (and make sure those responses are not spoofed or otherwise compromised). This file should contain the whole certificate chain. If this file does not contain the root certificate, LSWS should be able to find the root certificate in your system directory without you adding it to the file, but, if this validation fails, you should try adding your root certificate to this file.<br/><br/> This setting is optional. If this setting is not set, the server will automatically check <span class="tagl"><a href="#CACertFile">CA Certificate File</a></span>.</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"><div><header id="clientVerify"><h3>Client Verification<span class="ls-permlink"><a href="#clientVerify"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the type of client certifcate authentication. Available types are: <ul> <li><b>None:</b> No client certificate is required.</li> <li><b>Optional:</b> Client certificate is optional.</li> <li><b>Require:</b> The client must has valid certificate.</li> <li><b>Optional_no_ca:</b> Same as optional.</li> </ul> The default is "None".</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> "None" or "Require" are recommended.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="verifyDepth"><h3>Verify Depth<span class="ls-permlink"><a href="#verifyDepth"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies how deeply a certificate should be verified before determining that the client does not have a valid certificate. The default is "1".</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="crlPath"><h3>Client Revocation Path<span class="ls-permlink"><a href="#crlPath"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the directory containing PEM-encoded CA CRL files for revoked client certificates. The files in this directory have to be PEM-encoded. These files are accessed through hash filenames, hash-value.rN. Please refer to openSSL or Apache mod_ssl documentation regarding creating the hash filename.</p> <h4>Syntax</h4><p>path</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="crlFile"><h3>Client Revocation File<span class="ls-permlink"><a href="#crlFile"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> Specifies the file containing PEM-encoded CA CRL files enumerating revoked client certificates. This can be used as an alternative or in addition to <span class="tagl"><a href="#crlPath">Client Revocation Path</a></span>.</p> <h4>Syntax</h4><p>Filename which can be an absolute path or a relative path to $SERVER_ROOT.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>
CGI_Context.html 0000644 00000076452 15055121352 0007555 0 ustar 00 <!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - CGI Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - CGI Context." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico" />
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3 — Rev. 4</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License Enterprise</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu 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="Cache_Help.html">Page Cache</a></li>
<li><a href="PageSpeed_Config.html">PageSpeed Config</a></li>
<li><a href="ExtApp_Help.html">External Apps</a></li>
<ul class="level3">
<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_LSAPI.html">LSAPI App</a></li>
<li><a href="External_Servlet.html">Servlet Engine</a></li>
<li><a href="External_WS.html">Web Server</a></li>
<li><a href="External_PL.html">Piped logger</a></li>
<li><a href="External_LB.html">Load Balancer</a></li>
</ul>
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
<li><a href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App Server Settings</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 Basic</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="VHPageSpeed_Config.html">Virtual Host PageSpeed Config</a>
</li>
<li><a href="Rewrite_Help.html">Rewrite</a></li>
<li><a href="Context_Help.html">Context</a></li>
<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="LSAPI_Context.html">LSAPI Context</a></li>
<li><a href="Proxy_Context.html">Proxy Context</a></li>
<li><span class="current"><a href="CGI_Context.html">CGI Context</a></span></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="Rails_Context.html">Rack/Rails Context</a></li>
</ul>
<li><a href="VHAddOns_Help.html">Add-ons</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>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="Proxy_Context.html">Proxy Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="LB_Context.html">Load Balancer Context</a> »</div></div>
<h1>CGI Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#cgiContext">CGI Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#cgi_path">Path</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#allowSetUID">Allow Set UID</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a> | <a href="#addDefaultCharset">Add Default Charset</a> | <a href="#defaultCharsetCustomized">Customized Default Charset</a> | <a href="#enableRewrite">Enable Rewrite</a> | <a href="#rewriteInherit">Rewrite Inherit</a> | <a href="#rewriteBase">Rewrite Base</a> | <a href="#rewriteRules">Rewrite Rules</a> | <a href="#cachePolicy:maxStaleAge">Cache Stale Age (seconds)</a> | <a href="#cachePolicy:enableCache">Publicly Cache All</a> | <a href="#cachePolicy:expireInSeconds">Cache Expire Time (seconds)</a> | <a href="#cachePolicy:microCache5xx">Micro Cache 5XX Response</a> | <a href="#cachePolicy:enablePrivateCache">Privately Cache All</a> | <a href="#cachePolicy:privateExpireInSeconds">Private Cache Expire Time (seconds)</a> | <a href="#cachePolicy:enablePostCache">Enable POST cache</a> | <a href="#enableIpGeo">Enable GeoLocation Lookup</a> | <a href="#pagespeedEnabled">Enable PageSpeed Optimization</a> | <a href="#pagespeedParams">PageSpeed Settings</a> | <a href="#apacheConf">Apache Style Configurations</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="cgiContext"><h3>CGI Context<span class="ls-permlink"><a href="#cgiContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A CGI context defines scripts in a particular directory as CGI scripts. This directory can be inside or outside of the document root. When a file under this directory is requested, the server will always try to execute it as a CGI script, no matter if it's executable or not. In this way, file content under a CGI Context is always protected and cannot be read as static content. It is recommended that you put all your CGI scripts in a directory and set up a CGI Context to access them.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><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>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cgi_path"><h3>Path<span class="ls-permlink"><a href="#cgi_path"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the location of CGI scripts.</p> <h4>Syntax</h4><p>The path can be a directory that contains a group of CGI scripts, like <span class="val">$VH_ROOT/myapp/cgi-bin/</span>. In this case, the context <span class="tagl"><a href="#expuri">URI</a></span> must end with "/", like <span class="val">/app1/cgi/</span>. The Path can also specify only one CGI script, like <span class="val">$VH_ROOT/myapp/myscript.pl</span>. This script should have the corresponding <span class="tagl"><a href="#expuri">URI</a></span> <span class="val">/myapp/myscript.pl</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowSetUID"><h3>Allow Set UID<span class="ls-permlink"><a href="#allowSetUID"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether the set UID bit is allowed for CGI scripts. If the set UID bit is allowed and the set UID bit is enabled for a CGI script, no matter which user the CGI script was started on behalf of, the user ID of the CGI process will switch to the user ID of the owner of the CGI script.<br/> The default is "Off".</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> Do not allow Set UID CGI scripts whenever possible, as it is inherently a security risk.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="addDefaultCharset"><h3>Add Default Charset<span class="ls-permlink"><a href="#addDefaultCharset"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to add a character set tag to the "Content-Type" response header, when content type is either "text/html" or "text/plain" without any parameters. When set to <span class="val">Off</span>, this function is disabled. When set to <span class="val">On</span>, either the character set specified by <span class="tagl"><a href="#defaultCharsetCustomized">Customized Default Charset</a></span> or the default "iso-8859-1" will be added.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="defaultCharsetCustomized"><h3>Customized Default Charset<span class="ls-permlink"><a href="#defaultCharsetCustomized"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a character set to be used when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">On</span>. This is optional. The default value is <span class="val">iso-8859-1</span>. This entry has no effect when <span class="tagl"><a href="#addDefaultCharset">Add Default Charset</a></span> is <span class="val">Off</span>.</p> <h4>Syntax</h4><p>Name of a character set.</p> <h4>Example</h4><div class="ls-example">utf-8</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="enableRewrite"><h3>Enable Rewrite<span class="ls-permlink"><a href="#enableRewrite"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to enable LiteSpeed's URL rewrite engine. This option can be customized at the virtual host or context level, and is inherited along the directory tree until it is explicitly overridden.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteInherit"><h3>Rewrite Inherit<span class="ls-permlink"><a href="#rewriteInherit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to inherit rewrite rules from parent contexts. If rewrite is enabled and not inherited, rewrite base and rewrite rules defined in this context will be used.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteBase"><h3>Rewrite Base<span class="ls-permlink"><a href="#rewriteBase"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the base URL for rewrite rules.</p> <h4>Syntax</h4><p>URL</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="rewriteRules"><h3>Rewrite Rules<span class="ls-permlink"><a href="#rewriteRules"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies a list of rewrite rules at the virtual host level.<br/><br/> Do NOT add any document root level rewrite rules here. If you have any document root level rewrite rules from .htaccess, you should instead create a static context with uri "/" and add the rewrite rules there.<br/><br/> A rewrite rule is comprised of one <span class="val">RewriteRule</span> directive and optionally preceded by multiple <span class="val">RewriteCond</span> directives. <ul> <li>Each directive should take only one line.</li> <li> <span class="val">RewriteCond</span> and <span class="val">RewriteRule</span> follow Apache's rewrite directive syntax. Just copy and paste rewrite directives from your Apache configuration files. </li> <li> There are minor differences between LiteSpeed and Apache mod_rewrite implementation: <ul> <li> <span class="val">%\{LA-U:variable\}</span> and <span class="val">%\{LA-F:variable\}</span> are ignored by the LiteSpeed rewrite engine </li> <li> Two new server variables are added in the LiteSpeed rewrite engine: <span class="val">%\{CURRENT_URI\}</span> represents the current URI being processed by the rewrite engine and <span class="val">%\{SCRIPT_NAME\}</span> has the same meaning as the corresponding CGI environment variable. </li> <li> The LiteSpeed rewrite engine will stop processing rewrite rules after encountering an <span class="val">[L]</span> flag to avoid looping while Apache mod_rewrite will stop processing rewrite rules for the current iteration only. This behavior is similar to that of the <span class="val">[END]</span> flag in Apache mod_rewrite. </li> </ul> </li> </ul><br/> The implementation of LiteSpeed's rewrite engine follows Apache's rewrite engine specifications. For more details about rewrite rules, please refer to <a href="https://httpd.apache.org/docs/current/mod/mod_rewrite.html" target="_blank" rel="noopener noreferrer"> Apache's mod_rewrite document </a> and <a href="https://httpd.apache.org/docs/current/rewrite/" target="_blank" rel="noopener noreferrer"> Apache's URL rewriting guide </a>.</p> <h4>Syntax</h4><p>string</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:maxStaleAge"><h3>Cache Stale Age (seconds)<span class="ls-permlink"><a href="#cachePolicy:maxStaleAge"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will continue to be served from cache after it has expired but before a new cached copy is available. The default is "10" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enableCache"><h3>Publicly Cache All<span class="ls-permlink"><a href="#cachePolicy:enableCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Publicly cache all URLs served under the current context (virtual host, or context level).<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable" and "CacheDisable" directives at the server, virtual host, context, file, and location level or in .htaccess. "CacheEnable" and "CacheDisable" directives are compatible with Apache mod_cache directives. However, when used at the context, file, or location level, or in .htaccess, "CacheEnable" and "CacheDisable" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:expireInSeconds"><h3>Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:expireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached. The default is "86400" seconds (one day).</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:microCache5xx"><h3>Micro Cache 5XX Response<span class="ls-permlink"><a href="#cachePolicy:microCache5xx"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Cache pages responding with HTTP status code 5xx (500, 503, etc) for 10 seconds when the cache response header indicates that the page is cacheable.<br/><br/> Default values:<br/> <b>Server level:</b> Yes<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context-level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Enabling this setting is useful for avoiding bad requests but can also act as some added DDoS protection.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePrivateCache"><h3>Privately Cache All<span class="ls-permlink"><a href="#cachePolicy:enablePrivateCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Privately cache all URLs served under the current context (virtual host, or context level).<br/><br/> A separate cached copy will be made per user based on their IP and set cookies.<br/><br/> Virtual hosts configured through Apache's httpd.conf can use the "CacheEnable private /url" and "CacheDisable private /url" directives at server, virtual host, directory, file, and location levels or in a .htaccess file. "CacheEnable private" and "CacheDisable private" are compatible with Apache's mod_cache directives and will be applied to all directories below the current level. However, when used at the directory, file, or location level, or in a .htaccess file, "CacheEnable private" and "CacheDisable private" will only be applied to directories below the current level. URL parameters will be ignored.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Disabled by default. Do not enabled this setting if you are using any LSCache plugins.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:privateExpireInSeconds"><h3>Private Cache Expire Time (seconds)<span class="ls-permlink"><a href="#cachePolicy:privateExpireInSeconds"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies how long an object will be cached in private cache. The default is "60" seconds.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="cachePolicy:enablePostCache"><h3>Enable POST cache<span class="ls-permlink"><a href="#cachePolicy:enablePostCache"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies if POST requests can be cached using the "x-litespeed-cache-control" header.<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"><div><header id="enableIpGeo"><h3>Enable GeoLocation Lookup<span class="ls-permlink"><a href="#enableIpGeo"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p><span class="tag">Enterprise Edition Only</span> 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"><div><header id="pagespeedEnabled"><h3>Enable PageSpeed Optimization<span class="ls-permlink"><a href="#pagespeedEnabled"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Choose whether or not to enable PageSpeed optimization.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> This can be set at the Server Level and overridden at the Virtual Host and Context Levels. Context Level settings will override Virtual Host Level settings.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="pagespeedParams"><h3>PageSpeed Settings<span class="ls-permlink"><a href="#pagespeedParams"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Set parameters using Google default filter sets.</p> <h4>Example</h4><div class="ls-example"><br /> pagespeed FileCachePath /tmp/lshttpd/pagespeed;<br/> pagespeed RewriteLevel CoreFilters;</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="apacheConf"><h3>Apache Style Configurations<span class="ls-permlink"><a href="#apacheConf"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies Apache configuration directives (supported by LiteSpeed) that you want to use in LiteSpeed native configuration file. For example, to override the default PHP configurations (php.ini entries) the server will need four directives: "php_value", "php_flag", "php_admin_value" and "php_admin_flag".</p> <h4>Syntax</h4><p>Same as Apache configuration file.</p> </article> </div>
</section>
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2003-2020. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>