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 -
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. 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><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>