Spade
Mini Shell
<!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. 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>
<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>