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