<!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. 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><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>
| Name | Type | Size | Permission | Actions |
|---|---|---|---|---|
| css | Folder | 0755 |
|
|
| img | Folder | 0755 |
|
|
| AdminGeneral_Help.html | File | 18.47 KB | 0644 |
|
| AdminListeners_General_Help.html | File | 8.38 KB | 0644 |
|
| AdminListeners_SSL_Help.html | File | 19.73 KB | 0644 |
|
| AdminSecurity_Help.html | File | 9.91 KB | 0644 |
|
| App_Server_Context.html | File | 40.57 KB | 0644 |
|
| App_Server_Help.html | File | 26.16 KB | 0644 |
|
| CGI_Context.html | File | 31.29 KB | 0644 |
|
| Cache_Help.html | File | 18.45 KB | 0644 |
|
| Context_Help.html | File | 7.87 KB | 0644 |
|
| ExtApp_Help.html | File | 12.03 KB | 0644 |
|
| External_FCGI.html | File | 24.45 KB | 0644 |
|
| External_FCGI_Auth.html | File | 24.53 KB | 0644 |
|
| External_LB.html | File | 6.47 KB | 0644 |
|
| External_LSAPI.html | File | 24.53 KB | 0644 |
|
| External_PL.html | File | 13.03 KB | 0644 |
|
| External_Servlet.html | File | 11.17 KB | 0644 |
|
| External_WS.html | File | 11.24 KB | 0644 |
|
| FCGI_Context.html | File | 25.27 KB | 0644 |
|
| Java_Web_App_Context.html | File | 31.76 KB | 0644 |
|
| LB_Context.html | File | 25.34 KB | 0644 |
|
| LSAPI_Context.html | File | 25.56 KB | 0644 |
|
| Listeners_General_Help.html | File | 12.26 KB | 0644 |
|
| Listeners_SSL_Help.html | File | 23.61 KB | 0644 |
|
| PHP_Help.html | File | 24.56 KB | 0644 |
|
| PageSpeed_Config.html | File | 7.21 KB | 0644 |
|
| Proxy_Context.html | File | 22.87 KB | 0644 |
|
| Rails_Context.html | File | 36.97 KB | 0644 |
|
| Real_Time_Stats_Help.html | File | 6.99 KB | 0644 |
|
| Redirect_Context.html | File | 17.55 KB | 0644 |
|
| Rewrite_Help.html | File | 12.91 KB | 0644 |
|
| ScriptHandler_Help.html | File | 9.73 KB | 0644 |
|
| ServGeneral_Help.html | File | 52.47 KB | 0644 |
|
| ServLog_Help.html | File | 18.44 KB | 0644 |
|
| ServSecurity_Help.html | File | 72.11 KB | 0644 |
|
| ServTuning_Help.html | File | 55.81 KB | 0644 |
|
| ServerStat_Help.html | File | 21.67 KB | 0644 |
|
| Servlet_Context.html | File | 25.54 KB | 0644 |
|
| Static_Context.html | File | 38.37 KB | 0644 |
|
| Templates_Help.html | File | 14.79 KB | 0644 |
|
| VHAddOns_Help.html | File | 15.36 KB | 0644 |
|
| VHGeneral_Help.html | File | 40.31 KB | 0644 |
|
| VHPageSpeed_Config.html | File | 6.81 KB | 0644 |
|
| VHSSL_Help.html | File | 23.91 KB | 0644 |
|
| VHSecurity_Help.html | File | 44.14 KB | 0644 |
|
| VirtualHosts_Help.html | File | 21.48 KB | 0644 |
|
| admin.html | File | 7.84 KB | 0644 |
|
| config.html | File | 10.24 KB | 0644 |
|
| index.html | File | 6.01 KB | 0644 |
|
| install.html | File | 19.36 KB | 0644 |
|
| intro.html | File | 9.7 KB | 0644 |
|
| license.html | File | 13.14 KB | 0644 |
|
| security.html | File | 10.61 KB | 0644 |
|
| webconsole.html | File | 5.64 KB | 0644 |
|