mod_vhost_alias.html revision 2eaf662cbc81e823e8d9aeb8d54e69e63032493e
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Apache module mod_vhost_alias</title>
</head>
<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
<body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#000080" alink="#FF0000">
<!--#include virtual="header.html" -->
<h1 align="CENTER">Module mod_vhost_alias</h1>
<p>This module provides support for <a
hosting</a>.</p>
rel="Help"><strong>Status:</strong></a> Extension<br />
<a href="module-dict.html#SourceFile"
rel="Help"><strong>Source File:</strong></a>
mod_vhost_alias.c<br />
<a href="module-dict.html#ModuleIdentifier"
rel="Help"><strong>Module Identifier:</strong></a>
vhost_alias_module<br />
<a href="module-dict.html#Compatibility"
rel="Help"><strong>Compatibility:</strong></a> Available in
Apache 1.3.7 and later.</p>
<h2>Summary</h2>
<p>This module creates dynamically configured virtual hosts, by
the HTTP request to be used as part of the pathname to
determine what files to serve. This allows for easy use of a
huge number of virtual hosts with similar configurations.</p>
<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>
<p>See also: <a
<h2>Directory Name Interpolation</h2>
<p>All the directives in this module interpolate a string into
a pathname. The interpolated string (henceforth called the
"name") may be either the server name (see the <a
directive for details on how this is determined) or the IP
address of the virtual host on the server in dotted-quad
format. The interpolation is controlled by specifiers inspired
by <code>printf</code> which have a number of formats:</p>
<dl>
<dt><code>%%</code></dt>
<dd>insert a <code>%</code></dd>
<dt><code>%p</code></dt>
<dd>insert the port number of the virtual host</dd>
<dd>insert (part of) the name</dd>
</dl>
<br />
<br />
<p><code>N</code> and <code>M</code> are used to specify
substrings of the name. <code>N</code> selects from the
dot-separated components of the name, and <code>M</code>
selects characters within whatever <code>N</code> has selected.
<code>M</code> is optional and defaults to zero if it isn't
present; the dot must be present if and only if <code>M</code>
is present. The interpretation is as follows:</p>
<dl>
<dt><code>0</code></dt>
<dd>the whole name</dd>
<dt><code>1</code></dt>
<dd>the first part</dd>
<dt><code>2</code></dt>
<dd>the second part</dd>
<dt><code>-1</code></dt>
<dd>the last part</dd>
<dt><code>-2</code></dt>
<dd>the penultimate part</dd>
<dt><code>2+</code></dt>
<dd>the second and all subsequent parts</dd>
<dt><code>-2+</code></dt>
<dd>the penultimate and all preceding parts</dd>
<dt><code>1+</code> and <code>-1+</code></dt>
<dd>the same as <code>0</code></dd>
</dl>
If <code>N</code> or <code>M</code> is greater than the number
of parts available a single underscore is interpolated. <br />
<br />
<h3>Examples</h3>
<p>For simple name-based virtual hosts you might use the
following directives in your server configuration file:</p>
<pre>
UseCanonicalName Off
</pre>
A request for
satisfied by the file
<br />
<br />
<p>For a very large number of virtual hosts it is a good idea
to arrange the files to reduce the size of the
<code>vhosts</code> directory. To do this you might use the
following in your configuration file:</p>
<pre>
UseCanonicalName Off
</pre>
A request for
will be satisfied by the file
A more even spread of files can be achieved by hashing from the
end of the name, for example:
<pre>
</pre>
The example request would come from
Alternatively you might use:
<pre>
</pre>
The example request would come from
<br />
<br />
<p>For IP-based virtual hosting you might use the following in
your configuration file:</p>
<pre>
UseCanonicalName DNS
</pre>
A request for
would be satisfied by the file
10.20.30.40. A request for
be satisfied by executing the program
<br />
<br />
<p>If you want to include the <code>.</code> character in a
<code>VirtualDocumentRoot</code> directive, but it clashes with
a <code>%</code> directive, you can work around the problem in
the following way:</p>
<pre>
</pre>
A request for
will be satisfied by the file
<br />
<br />
directives</a> <code>%V</code> and <code>%A</code> are useful
in conjunction with this module.</p>
<hr />
<h2><a id="virtualdocumentroot"
name="virtualdocumentroot">VirtualDocumentRoot
directive</a></h2>
rel="Help"><strong>Syntax:</strong></a> VirtualDocumentRoot
<em>interpolated-directory</em><br />
<a href="directive-dict.html#Default"
rel="Help"><strong>Default:</strong></a> None<br />
<a href="directive-dict.html#Context"
rel="Help"><strong>Context:</strong></a> server config, virtual
host<br />
<a href="directive-dict.html#Status"
rel="Help"><strong>Status:</strong></a> Extension<br />
<a href="directive-dict.html#Module"
rel="Help"><strong>Module:</strong></a> mod_vhost_alias<br />
<a href="directive-dict.html#Compatibility"
rel="Help"><strong>Compatibility:</strong></a>
VirtualDocumentRoot is only available in 1.3.7 and later.</p>
<p>The <code>VirtualDocumentRoot</code> directive allows you to
determine where Apache will find your documents based on the
value of the server name. The result of expanding
<em>interpolated-directory</em> is used as the root of the
document tree in a similar manner to the <a
directive's argument. If <em>interpolated-directory</em> is
<code>none</code> then <code>VirtaulDocumentRoot</code> is
turned off. This directive cannot be used in the same context
as <a
href="#virtualdocumentrootip"><code>VirtualDocumentRootIP</code></a>.</p>
<hr />
<h2><a id="virtualdocumentrootip"
name="virtualdocumentrootip">VirtualDocumentRootIP
directive</a></h2>
rel="Help"><strong>Syntax:</strong></a> VirtualDocumentRootIP
<em>interpolated-directory</em><br />
<a href="directive-dict.html#Default"
rel="Help"><strong>Default:</strong></a> None<br />
<a href="directive-dict.html#Context"
rel="Help"><strong>Context:</strong></a> server config, virtual
host<br />
<a href="directive-dict.html#Status"
rel="Help"><strong>Status:</strong></a> Extension<br />
<a href="directive-dict.html#Module"
rel="Help"><strong>Module:</strong></a> mod_vhost_alias<br />
<a href="directive-dict.html#Compatibility"
rel="Help"><strong>Compatibility:</strong></a>
VirtualDocumentRootIP is only available in 1.3.7 and later.</p>
<p>The <code>VirtualDocumentRootIP</code> directive is like the
<a
href="#virtualdocumentroot"><code>VirtualDocumentRoot</code></a>
directive, except that it uses the IP address of the server end
of the connection instead of the server name.</p>
<hr />
<h2><a id="virtualscriptalias"
name="virtualscriptalias">VirtualScriptAlias directive</a></h2>
rel="Help"><strong>Syntax:</strong></a> VirtualScriptAlias
<em>interpolated-directory</em><br />
<a href="directive-dict.html#Default"
rel="Help"><strong>Default:</strong></a> None<br />
<a href="directive-dict.html#Context"
rel="Help"><strong>Context:</strong></a> server config, virtual
host<br />
<a href="directive-dict.html#Status"
rel="Help"><strong>Status:</strong></a> Extension<br />
<a href="directive-dict.html#Module"
rel="Help"><strong>Module:</strong></a> mod_vhost_alias<br />
<a href="directive-dict.html#Compatibility"
rel="Help"><strong>Compatibility:</strong></a>
VirtualScriptAlias is only available in 1.3.7 and later.</p>
<p>The <code>VirtualScriptAlias</code> directive allows you to
determine where Apache will find CGI scripts in a similar
manner to <a
href="#virtualdocumentroot"><code>VirtualDocumentRoot</code></a>
does for other documents. It matches requests for URIs starting
<code>/cgi-bin/</code>, much like <code><a
href="mod_alias.html#scriptalias">ScriptAlias</a>
/cgi-bin/</code> would.</p>
<hr />
<h2><a id="virtualscriptaliasip"
name="virtualscriptaliasip">VirtualScriptAliasIP
directive</a></h2>
rel="Help"><strong>Syntax:</strong></a> VirtualScriptAliasIP
<em>interpolated-directory</em><br />
<a href="directive-dict.html#Default"
rel="Help"><strong>Default:</strong></a> None<br />
<a href="directive-dict.html#Context"
rel="Help"><strong>Context:</strong></a> server config, virtual
host<br />
<a href="directive-dict.html#Status"
rel="Help"><strong>Status:</strong></a> Extension<br />
<a href="directive-dict.html#Module"
rel="Help"><strong>Module:</strong></a> mod_vhost_alias<br />
<a href="directive-dict.html#Compatibility"
rel="Help"><strong>Compatibility:</strong></a>
VirtualScriptAliasIP is only available in 1.3.7 and later.</p>
<p>The <code>VirtualScriptAliasIP</code> directive is like the
<a
href="#virtualscriptalias"><code>VirtualScriptAlias</code></a>
directive, except that it uses the IP address of the server end
of the connection instead of the server name.</p>
<hr />
<h3 align="CENTER">Apache HTTP Server Version 1.3</h3>
</body>
</html>