mod_vhost_alias.html revision 1b55e9e0a3c5fb40d9e46d3e6f711516a9a807fa
0N/A<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
2362N/AXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0N/A This file is generated from xml source: DO NOT EDIT
0N/AXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
0N/A--><title>mod_vhost_alias - Apache HTTP Server</title><link href="/style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="/images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_vhost_alias</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>This module provides support for <a href="/vhosts/mass.html">dynamically configured mass virtual
0N/Ahosting</a>.</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>vhost_alias_module</td></tr><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.3.7 and later.</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
0N/A
0N/A <p>This module creates dynamically configured virtual hosts, by
0N/A allowing the IP address and/or the <code>Host:</code> header of
0N/A the HTTP request to be used as part of the pathname to
0N/A determine what files to serve. This allows for easy use of a
0N/A huge number of virtual hosts with similar configurations.</p>
0N/A
0N/A <seealso>See also: <a href="core.html#usecanonicalname" class="directive"><code class="directive">UseCanonicalName</code></a>.</seealso>
2362N/A
0N/A</summary><h2>Directives</h2><ul><li><a href="#virtualdocumentroot">VirtualDocumentRoot</a></li><li><a href="#virtualdocumentrootip">VirtualDocumentRootIP</a></li><li><a href="#virtualscriptalias">VirtualScriptAlias</a></li><li><a href="#virtualscriptaliasip">VirtualScriptAliasIP</a></li></ul><h2>Directory Name Interpolation</h2>
0N/A
0N/A
0N/A <p>All the directives in this module interpolate a string into
0N/A a pathname. The interpolated string (henceforth called the
0N/A "name") may be either the server name (see the <a href="core.html#usecanonicalname"><code>UseCanonicalName</code></a>
0N/A directive for details on how this is determined) or the IP
0N/A address of the virtual host on the server in dotted-quad
0N/A format. The interpolation is controlled by specifiers inspired
0N/A by <code>printf</code> which have a number of formats:</p>
0N/A
0N/A<table>
0N/A
0N/A<tr><td><code>%%</code></td>
0N/A<td>insert a <code>%</code></td></tr>
0N/A
4378N/A<tr><td><code>%p</code></td>
4378N/A<td>insert the port number of the virtual host</td></tr>
4378N/A
4378N/A<tr><td><code>%N.M</code></td>
4378N/A<td>insert (part of) the name</td></tr>
4378N/A
4378N/A</table>
4378N/A
4378N/A <p><code>N</code> and <code>M</code> are used to specify
0N/A substrings of the name. <code>N</code> selects from the
0N/A dot-separated components of the name, and <code>M</code>
0N/A selects characters within whatever <code>N</code> has selected.
0N/A <code>M</code> is optional and defaults to zero if it isn't
0N/A present; the dot must be present if and only if <code>M</code>
0N/A is present. The interpretation is as follows:</p>
0N/A
0N/A <table>
0N/A <tr><td><code>0</code></td>
0N/A <td>the whole name</td></tr>
0N/A
0N/A <tr><td><code>1</code></td>
0N/A <td>the first part</td></tr>
0N/A
0N/A <tr><td><code>2</code></td>
0N/A <td>the second part</td></tr>
0N/A
0N/A <tr><td><code>-1</code></td>
0N/A <td>the last part</td></tr>
0N/A
0N/A <tr><td><code>-2</code></td>
0N/A <td>the penultimate part</td></tr>
0N/A
0N/A <tr><td><code>2+</code></td>
0N/A <td>the second and all subsequent parts</td></tr>
0N/A
0N/A <tr><td><code>-2+</code></td>
0N/A <td>the penultimate and all preceding parts</td></tr>
0N/A
0N/A <tr><td><code>1+</code> and <code>-1+</code></td>
0N/A <td>the same as <code>0</code></td></tr>
0N/A </table>
0N/A
0N/A <p>If <code>N</code> or <code>M</code> is greater than the number
0N/A of parts available a single underscore is interpolated. </p>
0N/A
0N/A<h2>Examples</h2>
0N/A
0N/A
0N/A <p>For simple name-based virtual hosts you might use the
0N/A following directives in your server configuration file:</p>
0N/A
0N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
0N/A UseCanonicalName Off<br>
0N/A VirtualDocumentRoot /usr/local/apache/vhosts/%0
0N/A</code></td></tr></table></blockquote>
0N/A
0N/A <p>A request for
0N/A <code>http://www.example.com/directory/file.html</code> will be
0N/A satisfied by the file
0N/A <code>/usr/local/apache/vhosts/www.example.com/directory/file.html</code>.
0N/A </p>
0N/A
0N/A <p>For a very large number of virtual hosts it is a good idea
0N/A to arrange the files to reduce the size of the
0N/A <code>vhosts</code> directory. To do this you might use the
0N/A following in your configuration file:</p>
0N/A
0N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
0N/A UseCanonicalName Off<br>
0N/A VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.1/%2.2/%2.3/%2
0N/A</code></td></tr></table></blockquote>
0N/A
0N/A <p>A request for
0N/A <code>http://www.example.isp.com/directory/file.html</code>
0N/A will be satisfied by the file
0N/A <code>/usr/local/apache/vhosts/isp.com/e/x/a/example/directory/file.html</code>.</p>
0N/A
0N/A <p>A more even spread of files can be achieved by hashing from the
0N/A end of the name, for example: </p>
0N/A
0N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
0N/A VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.-1/%2.-2/%2.-3/%2
0N/A</code></td></tr></table></blockquote>
0N/A
0N/A <p>The example request would come from
0N/A <code>/usr/local/apache/vhosts/isp.com/e/l/p/example/directory/file.html</code>.</p>
0N/A
0N/A <p>Alternatively you might use: </p>
0N/A
0N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
0N/A VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.1/%2.2/%2.3/%2.4+
0N/A</code></td></tr></table></blockquote>
0N/A
0N/A <p>The example request would come from
0N/A <code>/usr/local/apache/vhosts/isp.com/e/x/a/mple/directory/file.html</code>.</p>
0N/A
0N/A <p>For IP-based virtual hosting you might use the following in
0N/A your configuration file:</p>
0N/A
0N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
0N/A UseCanonicalName DNS<br>
0N/A VirtualDocumentRootIP /usr/local/apache/vhosts/%1/%2/%3/%4/docs<br>
0N/A VirtualScriptAliasIP /usr/local/apache/vhosts/%1/%2/%3/%4/cgi-bin
0N/A</code></td></tr></table></blockquote>
0N/A
0N/A <p>A request for
0N/A <code>http://www.example.isp.com/directory/file.html</code>
0N/A would be satisfied by the file
0N/A <code>/usr/local/apache/vhosts/10/20/30/40/docs/directory/file.html</code>
0N/A if the IP address of <code>www.example.com</code> were
0N/A 10.20.30.40. A request for
0N/A <code>http://www.example.isp.com/cgi-bin/script.pl</code> would
0N/A be satisfied by executing the program
0N/A <code>/usr/local/apache/vhosts/10/20/30/40/cgi-bin/script.pl</code>.</p>
0N/A
0N/A <p>If you want to include the <code>.</code> character in a
0N/A <code>VirtualDocumentRoot</code> directive, but it clashes with
0N/A a <code>%</code> directive, you can work around the problem in
0N/A the following way:</p>
0N/A
0N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
0N/A VirtualDocumentRoot /usr/local/apache/vhosts/%2.0.%3.0
0N/A</code></td></tr></table></blockquote>
0N/A
0N/A <p>A request for
0N/A <code>http://www.example.isp.com/directory/file.html</code>
0N/A will be satisfied by the file
0N/A <code>/usr/local/apache/vhosts/example.isp/directory/file.html</code>.</p>
0N/A
0N/A <p>The <a href="mod_log_config.html#logformat" class="directive"><code class="directive">LogFormat</code></a>
0N/A directives <code>%V</code> and <code>%A</code> are useful
0N/A in conjunction with this module.</p>
0N/A<hr/><h2><a name="VirtualDocumentRoot">VirtualDocumentRoot</a> <a name="virtualdocumentroot">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the document root
0N/Afor a given virtual host.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualDocumentRoot <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualDocumentRoot is only available in 1.3.7 and
0N/Alater.</td></tr></table></td></tr></table><usage>
0N/A
0N/A <p>The <code>VirtualDocumentRoot</code> directive allows you to
0N/A determine where Apache will find your documents based on the
0N/A value of the server name. The result of expanding
0N/A <em>interpolated-directory</em> is used as the root of the
0N/A document tree in a similar manner to the <a href="core.html#documentroot" class="directive"><code class="directive">DocumentRoot</code></a> directive's argument.
0N/A If <em>interpolated-directory</em> is <code>none</code> then
0N/A <code>VirtaulDocumentRoot</code> is turned off. This directive
0N/A cannot be used in the same context as
0N/A <code class="directive">VirtualDocumentRootIP</code>.</p>
0N/A
0N/A</usage><hr/><h2><a name="VirtualDocumentRootIP">VirtualDocumentRootIP</a> <a name="virtualdocumentrootip">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the document root
0N/Afor a given virtual host</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualDocumentRootIP <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualDocumentRootIP is only available in 1.3.7
0N/Aand later.</td></tr></table></td></tr></table><usage>
0N/A
0N/A<p>The <code>VirtualDocumentRootIP</code> directive is like the
0N/A <code class="directive">VirtualDocumentRoot</code>
0N/A directive, except that it uses the IP address of the server end
0N/A of the connection instead of the server name.</p>
0N/A</usage><hr/><h2><a name="VirtualScriptAlias">VirtualScriptAlias</a> <a name="virtualscriptalias">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the CGI directory for
0N/Aa given virtual host.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualScriptAlias <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualScriptAlias is only available in 1.3.7
0N/Aand later.</td></tr></table></td></tr></table><usage>
0N/A
0N/A <p>The <code>VirtualScriptAlias</code> directive allows you to
0N/A determine where Apache will find CGI scripts in a similar
0N/A manner to <code class="directive">VirtualDocumentRoot</code>
0N/A does for other documents. It matches requests for URIs starting
0N/A <code>/cgi-bin/</code>, much like <a href="mod_alias.html#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a>
0N/A <code>/cgi-bin/</code> would.</p>
0N/A
0N/A</usage><hr/><h2><a name="VirtualScriptAliasIP">VirtualScriptAliasIP</a> <a name="virtualscriptaliasip">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Dynamically configure the location of the cgi directory for
0N/Aa given virtual host.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>VirtualScriptAliasIP <em>interpolated-directory</em></syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>none</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td/></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_vhost_alias</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>VirtualScriptAliasIP is only available in 1.3.7
0N/Aand later.</td></tr></table></td></tr></table><usage>
0N/A
0N/A <p>The <code>VirtualScriptAliasIP</code> directive is like the
0N/A <a href="#virtualscriptalias"><code>VirtualScriptAlias</code></a>
0N/A directive, except that it uses the IP address of the server end
0N/A of the connection instead of the server name.</p>
0N/A
0N/A </usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="/images/index.gif"/></a><a href="../"><img alt="Home" src="/images/home.gif"/></a></blockquote></body></html>