mod_vhost_alias.html revision 43e06a6b71f9a97183b1e292297ec104079e431c
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<TITLE>Apache module mod_vhost_alias</TITLE>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana BGCOLOR="#FFFFFF"
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana TEXT="#000000"
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana LINK="#0000FF"
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana VLINK="#000080"
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana ALINK="#FF0000"
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <IMG SRC="/images/sub.gif" ALT="[APACHE DOCUMENTATION]">
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana Apache HTTP Server Version 1.3
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<H1 ALIGN="CENTER">Module mod_vhost_alias</H1>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaThis module is contained in the <CODE>mod_vhost_alias.c</CODE> file
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanaand is not compiled in by default. It provides support for
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<A HREF="/vhosts/mass.html">dynamically configured mass virtual
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaAll the directives in this module interpolate a string into a
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanapathname. The interpolated string (henceforth called the "name") may
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanabe either the server name (see the
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<A HREF="core.html#usecanonicalname"><CODE>UseCanonicalName</CODE></A>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanadirective for details on how this is determined) or the IP address of
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanathe virtual host on the server in dotted-quad format. The
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanainterpolation is controlled by specifiers inspired by
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>printf</CODE> which have a number of formats:
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DD>insert the port number of the virtual host
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DD>insert (part of) the name
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>N</CODE> and <CODE>M</CODE> are used to specify substrings of
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanathe name. <CODE>N</CODE> selects from the dot-separated components of
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanathe name, and <CODE>M</CODE> selects characters within whatever
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>N</CODE> has selected. <CODE>M</CODE> is optional and defaults
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanato zero if it isn't present; the dot must be present if and only if
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>M</CODE> is present. The interpretation is as follows:
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DD>the whole name
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DD>the first part
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DD>the second part
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DD>the last part
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DD>the penultimate part
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DD>the second and all subsequent parts
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DD>the penultimate and all preceding parts
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <DT><CODE>1+</CODE> and <CODE>-1+</CODE>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaIf <CODE>N</CODE> or <CODE>M</CODE> is greater than the number of
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanaparts available a single underscore is interpolated.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaFor simple name-based virtual hosts you might use the following
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanadirectives in your server configuration file:
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana UseCanonicalName Off
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana VirtualDocumentRoot /usr/local/apache/vhosts/%0
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaA request for <CODE>http://www.example.com/directory/file.html</CODE>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanawill be satisfied by the file
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>/usr/local/apache/vhosts/www.example.com/directory/file.html</CODE>.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaFor a very large number of virtual hosts it is a good idea to arrange
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanathe files to reduce the size of the <CODE>vhosts</CODE> directory. To
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanado this you might use the following in your configuration file:
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana UseCanonicalName Off
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.1/%2.2/%2.3/%2
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaA request for <CODE>http://www.example.isp.com/directory/file.html</CODE>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanawill be satisfied by the file
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>/usr/local/apache/isp.com/e/x/a/example/directory/file.html</CODE>.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaA more even spread of files can be achieved by hashing from the end of
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanathe name, for example:
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.-1/%2.-2/%2.-3/%2
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaThe example request would come from
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>/usr/local/apache/vhosts/isp.com/e/l/p/example/directory/file.html</CODE>.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaAlternatively you might use:
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.1/%2.2/%2.3/%2.4+
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaThe example request would come from
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>/usr/local/apache/vhosts/isp.com/e/x/a/mple/directory/file.html</CODE>.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaFor IP-based virtual hosting you might use the following in your
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanaconfiguration file:
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana UseCanonicalName DNS
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana VirtualDocumentRootIP /usr/local/apache/vhost/%1/%2/%3/%4/docs
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana VirtualScriptAliasIP /usr/local/apache/vhost/%1/%2/%3/%4/cgi-bin
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaA request for <CODE>http://www.example.isp.com/directory/file.html</CODE>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanawould be satisfied by the file
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>/usr/local/apache/10/20/30/40/docs/directory/file.html</CODE> if
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanathe IP address of <CODE>www.example.com</CODE> were 10.20.30.40.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaA request for <CODE>http://www.example.isp.com/cgi-bin/script.pl</CODE>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanawould be satisfied by executing the program
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>/usr/local/apache/10/20/30/40/cgi-bin/script.pl</CODE>.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaThe <A HREF="mod_log_config.html#formats">LogFormat directives</A>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>%V</CODE> and <CODE>%A</CODE> are useful in conjunction with
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <LI><A HREF="#virtualdocumentroot">VirtualDocumentRoot</A>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <LI><A HREF="#virtualdocumentrootip">VirtualDocumentRootIP</A>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <LI><A HREF="#virtualscriptalias">VirtualScriptAlias</A>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana <LI><A HREF="#virtualscriptaliasip">VirtualScriptAliasIP</A>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<H2><A NAME="virtualdocumentroot">VirtualDocumentRoot directive</A></H2>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Syntax:</STRONG></A> VirtualDocumentRoot <EM>interpolated-directory</EM><BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Context:</STRONG></A> server config, virtual host<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Status:</STRONG></A> Extension<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Module:</STRONG></A> mod_vhost_alias<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana HREF="directive-dict.html#Compatibility"
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Compatibility:</STRONG></A> VirtualDocumentRoot is only available in 1.3.7 and later.</P>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaThe <CODE>VirtualDocumentRoot</CODE> directive allows you to determine
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanawhere Apache will find your documents based on the value of the server
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushananame. The result of expanding <EM>interpolated-directory</EM> is used
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanaas the root of the document tree in a similar manner to the
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<A HREF="core.html#documentroot"><CODE>DocumentRoot</CODE></A>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanadirective's argument. If <EM>interpolated-directory</EM> is
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE>none</CODE> then <CODE>VirtaulDocumentRoot</CODE> is turned off.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaThis directive cannot be used in the same context as
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<A HREF="#virtualdocumentrootip"><CODE>VirtualDocumentRootIP</CODE></A>.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<H2><A NAME="virtualdocumentrootip">VirtualDocumentRootIP directive</A></H2>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Syntax:</STRONG></A> VirtualDocumentRootIP <EM>interpolated-directory</EM><BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Context:</STRONG></A> server config, virtual host<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Status:</STRONG></A> Extension<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Module:</STRONG></A> mod_vhost_alias<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana HREF="directive-dict.html#Compatibility"
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Compatibility:</STRONG></A> VirtualDocumentRootIP is only available in 1.3.7 and later.</P>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaThe <CODE>VirtualDocumentRootIP</CODE> directive is like the
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<A HREF="#virtualdocumentroot"><CODE>VirtualDocumentRoot</CODE></A> directive,
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanaexcept that it uses the IP address of the server end of the connection
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanainstead of the server name.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<H2><A NAME="virtualscriptalias">VirtualScriptAlias directive</A></H2>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Syntax:</STRONG></A> VirtualScriptAlias <EM>interpolated-directory</EM><BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Context:</STRONG></A> server config, virtual host<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Status:</STRONG></A> Extension<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Module:</STRONG></A> mod_vhost_alias<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana HREF="directive-dict.html#Compatibility"
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Compatibility:</STRONG></A> VirtualScriptAlias is only available in 1.3.7 and later.</P>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaThe <CODE>VirtualScriptAlias</CODE> directive allows you to determine
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanawhere Apache will find CGI scripts in a similar manner to
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<A HREF="#virtualdocumentroot"><CODE>VirtualDocumentRoot</CODE></A>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanadoes for other documents. It matches requests for URIs starting
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<CODE><A HREF="mod_alias.html#scriptalias">ScriptAlias</A> /cgi-bin/</CODE>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<H2><A NAME="virtualscriptaliasip">VirtualScriptAliasIP directive</A></H2>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Syntax:</STRONG></A> VirtualScriptAliasIP <EM>interpolated-directory</EM><BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Context:</STRONG></A> server config, virtual host<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Status:</STRONG></A> Extension<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Module:</STRONG></A> mod_vhost_alias<BR>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana HREF="directive-dict.html#Compatibility"
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana><STRONG>Compatibility:</STRONG></A> VirtualScriptAliasIP is only available in 1.3.7 and later.</P>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh NagabhushanaThe <CODE>VirtualScriptAliasIP</CODE> directive is like the
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<A HREF="#virtualscriptalias"><CODE>VirtualScriptAlias</CODE></A> directive,
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanaexcept that it uses the IP address of the server end of the connection
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushanainstead of the server name.
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana Apache HTTP Server Version 1.3
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<A HREF="./"><IMG SRC="/images/index.gif" ALT="Index"></A>
56b2bdd1f04d465cfe4a95b88ae5cba5884154e4Gireesh Nagabhushana<A HREF="../"><IMG SRC="/images/home.gif" ALT="Home"></A>
