Edit File: VirtualHosts_Help.html
<!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.2 — Rev. 0</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> </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>