<!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Listeners General</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Listeners General." />
<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. 2</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><span class="current"><a href="Listeners_General_Help.html">Listener General</a></span></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="App_Server_Help.html">App Server Settings</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="Listeners_SSL_Help.html">Listeners SSL</a> »</div></div>
<h1>Listeners General</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header>Address Settings</header><p>
<a href="#listenerName">Listener Name</a> | <a href="#listenerIP">IP Address</a> | <a href="#listenerPort">Port</a> | <a href="#listenerBinding">Binding</a> | <a href="#reusePort">Enable REUSEPORT</a> | <a href="#listenerSecure">Secure</a></p></section>
<section class="toc-row"><header><a href="#virtualHostMapping">Virtual Host Mappings</a></header><p>
<a href="#virtualHostName">Virtual Host</a> | <a href="#domainName">Domains</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="listenerName"><h3>Listener Name<span class="ls-permlink"><a href="#listenerName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A unique name for this listener.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerIP"><h3>IP Address<span class="ls-permlink"><a href="#listenerIP"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the IP of this listener. All available IP addresses are listed. IPv6 addresses are enclosed in "[ ]".<br/><br/> To listen on all IPv4 IP addresses, select <span class="val">ANY</span>. To listen on all IPv6 IP addresses, select <span class="val">[ANY] IPv6</span>. If <span class="val">No</span> is selected for setting <span class="tagl"><a href="#bindIPv6Only">Bind IPv6 Only</a></span>, selecting <span class="val">[ANY] IPv6</span> will listen on IPv4 addresses as well.<br/><br/> By default, LiteSpeed uses separate listeners for IPv4 and IPv6 addresses. Should the need to serve both IPv4 and IPv6 arise, separate listeners should be created for each.</p> <h4>Syntax</h4><p>Select from drop down list</p> <h4>Tips</h4><p><span title="Security" class="ls-icon-security"></span> If your machine has multiple IPs on different sub-networks, you can select a specific IP to only allow traffic from the corresponding sub-network.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerPort"><h3>Port<span class="ls-permlink"><a href="#listenerPort"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the TCP port of the listener. Only the super user ("root") can use ports lower than <span class="val">1024</span>. Port <span class="val">80</span> is the default HTTP port. Port <span class="val">443</span> is the default HTTPS port.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerBinding"><h3>Binding<span class="ls-permlink"><a href="#listenerBinding"></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 which lshttpd child process the listener is assigned to. Enterprise Edition spawns multiple child processes to take advantage of the multiple CPUs in a SMP system. Different child processes can be used to handle requests to different listeners by manually associating a listener with a process. By default, a listener is assigned to all child processes.</p> <h4>Syntax</h4><p>Select from checkbox</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="reusePort"><h3>Enable REUSEPORT<span class="ls-permlink"><a href="#reusePort"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Use SO_REUSEPORT socket option to distribute incoming traffic to multiple workers. This setting is only effective for multi-worker licenses. When enabled, all workers are automatically bound to this listener and "Binding" configuration is ignored.<br/><br/> Default value: On</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="listenerSecure"><h3>Secure<span class="ls-permlink"><a href="#listenerSecure"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether this is a secure (SSL) listener. For secure listeners, additional SSL settings need to be set properly.</p> <h4>Syntax</h4><p>Select from radio box</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="virtualHostMapping"><h3>Virtual Host Mappings<span class="ls-permlink"><a href="#virtualHostMapping"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the relationship between the listener and virtual hosts. Listeners and virtual hosts are associated by domain names. An HTTP request will be routed to a virtual host with a matching domain name. One listener can map to multiple virtual hosts for different domain names. One virtual host can also be mapped from different listeners. One listener can allow one catchall virtual host with the domain name value "*". When there is no explicitly matched domain name in the listener's mapping, the listener will forward the request to that catchall virtual host.</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Only add necessary mappings. If the listener is mapped to only one virtual host, then only set up a catchall mapping "*".</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="virtualHostName"><h3>Virtual Host<span class="ls-permlink"><a href="#virtualHostName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the name of a virtual host.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="domainName"><h3>Domains<span class="ls-permlink"><a href="#domainName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the mapping domain names. Domain names are case insensitive and the leading "www." will be removed. The wildcard characters "*" and "?" are allowed. "?" only represents one character. "*" represents any numbers of characters. Duplicated domain names are not allowed.</p> <h4>Syntax</h4><p>Comma-separated list.</p> <h4>Example</h4><div class="ls-example">www?.example.com<br/> "*.mydomain.com" will match all subdomains of mydomain.com.<br/> "*" by itself is the catchall domain and will match any unmatched domain names.</div><h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If a listener is dedicated to one virtual host, always use <span class="val">*</span> for the domain name to avoid unnecessary checking. Domain names with wildcard characters (other than the catchall domain) should be avoided whenever possible.</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>
