<!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Redirect Context</title>
<meta name="description" content="LiteSpeed Web Server Users' Manual - Redirect Context." />
<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><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><span class="current"><a href="Redirect_Context.html">Redirect Context</a></span></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="LB_Context.html">Load Balancer Context</a></div><div class="center"><a href="Context_Help.html">Context</a></div><div class="next"><a href="App_Server_Context.html">App Server Context</a> »</div></div>
<h1>Redirect Context</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#redirectContext">Redirect Context</a></header><p>
<a href="#expuri">URI</a> | <a href="#externalredirect">External Redirect</a> | <a href="#statuscode">Status Code</a> | <a href="#destinationuri">Destination URI</a> | <a href="#extraHeaders">Header Operations</a> | <a href="#allowOverride">Allow Override</a> | <a href="#realm">Realm</a> | <a href="#authName">Authentication Name</a> | <a href="#required">Require (Authorized Users/Groups)</a> | <a href="#accessAllowed">Access Allowed</a> | <a href="#accessDenied">Access Denied</a> | <a href="#extAuthorizer">Authorizer</a></p></section>
</section>
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="redirectContext"><h3>Redirect Context<span class="ls-permlink"><a href="#redirectContext"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A Redirect Context can be used to forward one URI or a group of URIs to another location. The destination URI can be either on the same web site (an internal redirect) or an absolute URI pointing to another web site (an external redirect).</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="expuri"><h3>URI<span class="ls-permlink"><a href="#expuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the URI for this context.</p> <h4>Syntax</h4><p>The URI can be a plain URI (starting with "/") or a Perl compatible regular expression URI (starting with "exp:"). If a plain URI ends with a "/", then this context will include all sub-URIs under this URI. If the context maps to a directory on the file system, a trailing "/" must be added.</p> <h4>See Also</h4><p class="ls-text-small"><span class="tagl"><a href="#location">Location</a></span></p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="externalredirect"><h3>External Redirect<span class="ls-permlink"><a href="#externalredirect"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether this redirect is external. For external redirection, <span class="tagl"><a href="#statuscode">Status Code</a></span> may be specified and <span class="tagl"><a href="#destinationuri">Destination URI</a></span> can start either with "/" or "http(s)://". For internal redirection, <span class="tagl"><a href="#destinationuri">Destination URI</a></span> must start with "/".</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="statuscode"><h3>Status Code<span class="ls-permlink"><a href="#statuscode"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the response status code of the external redirection. If the status code is between 300 and 399, <span class="tagl"><a href="#destinationuri">Destination URI</a></span> can be specified.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="destinationuri"><h3>Destination URI<span class="ls-permlink"><a href="#destinationuri"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the target location of the redirect. If this redirected URI maps to a URI in another redirect context, it will be redirected again.</p> <h4>Syntax</h4><p>This URI can either be a relative URI on the same web site starting with "/", or an absolute URI pointing to different web site starting with "http(s)://". If the <span class="tagl"><a href="#expuri">URI</a></span> contains regular expressions, the destination can reference the matched variables, such as $1 or $2.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extraHeaders"><h3>Header Operations<span class="ls-permlink"><a href="#extraHeaders"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies additional response/request headers to be added. Multiple header directives can be added with one directive per line. "NONE" can be used to disable parent header inheritance. If no directive is provided 'Header' is assumed.</p> <h4>Syntax</h4><p>[Header]|RequestHeader [condition] set|append|merge|add|unset header [value] [early|env=[!]variable]</p> <h4>Example</h4><div class="ls-example">set Cache-control no-cache<br/> append Cache-control no-store<br/> Header set My-header cust_header_val<br/> RequestHeader set My-req-header cust_req_header_val</div><h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> Syntax and usage are similar to <a href="https://httpd.apache.org/docs/2.2/mod/mod_headers.html#header" target="_blank" rel="noopener noreferrer">Apache's mod_headers directives</a> for supported operations.<br/><br/> <span title="Information" class="ls-icon-info"></span> The 'Header' directive is is optional and can be excluded or left in when copying rules from elsewhere without issue.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="allowOverride"><h3>Allow Override<span class="ls-permlink"><a href="#allowOverride"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies what directives in an access control file are allowed. An access control file can be placed in a directory to control the accessibility of files under that directory.<br/> <ul> <li>When nothing is checked, inherited default settings will be used.</li> <li>When <span class="val">None</span> is checked, access control files will be ignored.</li> <li> When <span class="val">Limit</span> is checked, directives "Allow", "Deny", and "Order" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">Auth</span> is checked, directives "AuthGroupFile", "AuthName", "AuthType", "AuthUserFile", "Require", and "Satisfy" are allowed. <Limit> and <LimitExcept> directives are also allowed with limited support for GET, HEAD, and POST requests. </li> <li> When <span class="val">FileInfo</span> is checked, directives "AddDefaultCharset", "AddType", "DefaultType", "ForceType", "Redirect", "RedirectPermanent", "RedirectTemp", "RewriteBase", "RewriteCond", "RewriteEngine", "RewriteOptions", and "RewriteRule" are allowed. </li> <li> When <span class="val">Indexes</span> is checked, directives "DirectoryIndex", "ExpiresActive", "ExpiresByType", and "ExpiresDefault" are allowed. </li> <li>When <span class="val">Options</span> is checked, directive "Options" is allowed.</li> </ul><br/> Allow Override configuration is available at the Server, Virtual Host, and Context levels. If a configuration is unchecked at the Server level, those controlled directives will be disabled for the entire server regardless of settings at lower levels. Lower levels can disable a setting that is enabled at a higher level, but cannot enable a setting that is disabled at an upper level.<br/><br/> Default values:<br/> <b>Server level:</b> "None" (ignore access control file)<br/> <b>VH level:</b> Inherit Server level setting<br/> <b>Context level</b> Inherit VH level setting</p> <h4>Syntax</h4><p>Select from checkbox</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If there is no need for directory level configuration customization, check <span class="val">None</span>.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="realm"><h3>Realm<span class="ls-permlink"><a href="#realm"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the authorization realm for this context. When specified, a valid username and password must be provided in order to access this context. <span class="tagl"><a href="VHSecurity_Help.html#realms">Authorization Realms</a></span> are set up in the <span class="tagP"><a href="#VHSecurity_Help">Virtual Host Security</a></span> section. This setting uses each realm's <span class="tagl"><a href="VHSecurity_Help.html#realmName">Realm Name</a></span>.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="authName"><h3>Authentication Name<span class="ls-permlink"><a href="#authName"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an alternative name for the authorization realm for the current context. If not specified, the original realm name will be used. The authentication name is displayed on the browser's login pop-up.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="required"><h3>Require (Authorized Users/Groups)<span class="ls-permlink"><a href="#required"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which user/group can access this context. This allows you to use one user/group database (specified in <span class="tagl"><a href="#realm">Realm</a></span>) across a number of contexts, but only allow certain users/groups from that database to access this context.</p> <h4>Syntax</h4><p>Syntax is compatible with Apache's Require directive. For example: <ul> <li><span class="val">user username [username ...]</span><br/> Only listed users can access this context.</li> <li> <span class="val">group groupid [groupid ...]</span><br/> Only users belonging to the listed groups can access this context.</li> </ul> If this setting is not specified, all valid users will be allowed to access this resource.</p> </article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessAllowed"><h3>Access Allowed<span class="ls-permlink"><a href="#accessAllowed"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are allowed to access resources under this context. Together with <span class="tagl"><a href="#accessDenied">Access Denied</a></span> and server/virtual host level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="accessDenied"><h3>Access Denied<span class="ls-permlink"><a href="#accessDenied"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which IPs or sub-networks are NOT allowed to access resources under this context. Together with <span class="tagl"><a href="#accessAllowed">Access Allowed</a></span> and server/virtual host-level access control, accessibility is determined by the smallest scope that a client's IP address falls into.</p> <h4>Syntax</h4><p>Comma-delimited list of IPs/sub-networks.</p> <h4>Example</h4><div class="ls-example">Sub-networks can be written as <span class="val">192.168.1.0/255.255.255.0</span>, <span class="val">192.168.1</span>, or <span class="val">192.168.1.*</span>.</div></article> </div>
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAuthorizer"><h3>Authorizer<span class="ls-permlink"><a href="#extAuthorizer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies an external application that can be used to generate authorized/unauthorized decisions. Currently, only the FastCGI Authorizer is available. For more details about the FastCGI Authorizer role, please visit <a href=" https://fastcgi-archives.github.io/ " target="_blank" rel="noopener noreferrer"> https://fastcgi-archives.github.io/ </a>.</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>
