examples.html revision 16cd57216198a2178dec0adf6c66c508bfda6b6b
8N/A<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
8N/A<HTML><HEAD>
371N/A<TITLE>VirtualHost Examples</TITLE>
8N/A</HEAD>
8N/A
8N/A<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
8N/A<BODY
8N/A BGCOLOR="#FFFFFF"
8N/A TEXT="#000000"
8N/A LINK="#0000FF"
8N/A VLINK="#000080"
8N/A ALINK="#FF0000"
8N/A>
8N/A<!--#include virtual="header.html" -->
8N/A<H1 ALIGN="CENTER">Virtual Host examples for common setups</H1>
8N/A
8N/A
8N/A<H2>Base configuration</H2>
8N/A
8N/A<UL>
8N/A<LI><A HREF="#purename">Simple name-based vhosting</A>
8N/A<LI><A HREF="#name">More complicated name-based vhosts</A>
8N/A<LI><A HREF="#ip">IP-based vhosts</A>
8N/A<LI><A HREF="#mixed">Mixed name-/IP-based vhosts</A>
8N/A<LI><A HREF="#port">Port-based vhosts</A>
8N/A</UL>
8N/A
8N/A<H2>Additional features</H2>
8N/A
8N/A<UL>
493N/A<LI><A HREF="#default">Using <CODE>_default_</CODE> vhosts</A>
8N/A<LI><A HREF="#migrate">Migrating a named-based vhost to an IP-based vhost</A>
8N/A<LI><A HREF="#serverpath">Using the <CODE>ServerPath</CODE> directive</A>
32N/A</UL>
493N/A
8N/A<HR>
8N/A
493N/A<H3><A NAME="purename">Simple name-based vhosting</A></H3>
8N/A
8N/A<UL>
371N/A
8N/A<LI><STRONG>Setup:</STRONG>
8N/A The server machine has a primary name <SAMP>server.domain.tld</SAMP>.
32N/A There are two aliases (CNAMEs) <SAMP>www.domain.tld</SAMP> and
8N/A <SAMP>www.sub.domain.tld</SAMP> for the address <SAMP>server.domain.tld</SAMP>.
32N/A <P>
32N/A <STRONG>Server configuration:</STRONG>
8N/A
493N/A <BLOCKQUOTE><PRE>
8N/A ...
Listen 80
ServerName server.domain.tld
NameVirtualHost *
&lt;VirtualHost *&gt;
DocumentRoot /www/domain
ServerName www.domain.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost *&gt;
DocumentRoot /www/subdomain
ServerName www.sub.domain.tld
...
&lt;/VirtualHost&gt;
</PRE>
The asterisks match all addresses, so the main server serves no
requests. Due to the fact that <SAMP>www.domain.tld</SAMP> is first
in the configuration file, it has the highest priority and can be
seen as the <CITE>default</CITE> or <CITE>primary</CITE> server.
</BLOCKQUOTE>
<P>
</UL>
<HR>
<H3><A NAME="name">More complicated name-based vhosts</A></H3>
<UL>
<LI><STRONG>Setup 1:</STRONG>
The server machine has one IP address (<SAMP>111.22.33.44</SAMP>)
which resolves to the name <SAMP>server.domain.tld</SAMP>.
There are two aliases (CNAMEs) <SAMP>www.domain.tld</SAMP> and
<SAMP>www.sub.domain.tld</SAMP> for the address <SAMP>111.22.33.44</SAMP>.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
Listen 80
ServerName server.domain.tld
NameVirtualHost 111.22.33.44
&lt;VirtualHost 111.22.33.44&gt;
DocumentRoot /www/domain
ServerName www.domain.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.44&gt;
DocumentRoot /www/subdomain
ServerName www.sub.domain.tld
...
&lt;/VirtualHost&gt;
</PRE>
Apart from <SAMP>localhost</SAMP> there are no unspecified
addresses/ports, therefore the main server only serves
<SAMP>localhost</SAMP> requests. Due to the fact
that <SAMP>www.domain.tld</SAMP> has the highest priority
it can be seen as the <CITE>default</CITE> or
<CITE>primary</CITE> server.
</BLOCKQUOTE>
<P>
<LI><STRONG>Setup 2:</STRONG>
The server machine has two IP addresses (<SAMP>111.22.33.44</SAMP>
and <SAMP>111.22.33.55</SAMP>)
which resolve to the names <SAMP>server1.domain.tld</SAMP> and
<SAMP>server2.domain.tld</SAMP> respectively.
The alias <SAMP>www.domain.tld</SAMP> should be used for the
main server which should also catch any unspecified addresses.
We want to use a virtual host for the alias
<SAMP>www.otherdomain.tld</SAMP> and another virtual host,
with server name <SAMP>www.sub.domain.tld</SAMP>, should
catch any request to hostnames of the form
<SAMP>*.sub.domain.tld</SAMP>.
The address <SAMP>111.22.33.55</SAMP> should be
used for the virtual hosts.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
Listen 80
ServerName www.domain.tld
DocumentRoot /www/domain
NameVirtualHost 111.22.33.55
&lt;VirtualHost 111.22.33.55&gt;
DocumentRoot /www/otherdomain
ServerName www.otherdomain.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.55&gt;
DocumentRoot /www/subdomain
ServerName www.sub.domain.tld
ServerAlias *.sub.domain.tld
...
&lt;/VirtualHost&gt;
</PRE>
Any request to an address other than <SAMP>111.22.33.55</SAMP>
will be served from the main server. A request to
<SAMP>111.22.33.55</SAMP> with an unknown or no <CODE>Host:</CODE>
header will be served from <SAMP>www.otherdomain.tld</SAMP>.
</BLOCKQUOTE>
<LI><STRONG>Setup 3:</STRONG>
The server machine has two IP addresses (<SAMP>192.168.1.1</SAMP>
and <SAMP>111.22.33.55</SAMP>). The machine is sitting between
an internal (intranet) network and an external (internet) network.
Outside of the network, the name <SAMP>server1.domain.tld</SAMP>
resolves to the external address (<SAMP>111.22.33.55</SAMP>), but
inside the network, that same name resolves to the internal
address (<SAMP>192.168.1.1</SAMP>).<P>
The server can be made to respond to internal and external
requests with the same content, with just one <CODE>VirtualHost</CODE>
section.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
NameVirtualHost 192.168.1.1
NameVirtualHost 111.22.33.55
&lt;VirtualHost 192.168.1.1 111.22.33.55&gt;
DocumentRoot /www/server1
ServerName server1.domain.tld
ServerAlias server1
...
&lt;/VirtualHost&gt;
</PRE></BLOCKQUOTE>
Now requests from both networks will be served from the same
<CODE>VirtualHost</CODE>
<LI><STRONG>Setup 4:</STRONG>
You have multiple domains going to the same IP and also want
to serve multiple ports. By defining the
ports in the "NameVirtualHost" tag, you can allow this to
work. If you try using <VirtualHost name:port> without the
NameVirtualHost name:port or you try to use the Listen
directive, your configuration will not work.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
NameVirtualHost 111.22.33.44:80
NameVirtualHost 111.22.33.44:8080
&lt;VirtualHost 111.22.33.44:80&gt;
ServerName www.domain.tld
DocumentRoot /www/domain-80
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.44:8080&gt;
ServerName www.domain.tld
DocumentRoot /www/domain-8080
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.44:80&gt;
ServerName www.otherdomain.tld
DocumentRoot /www/otherdomain-80
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.44:8080&gt;
ServerName www.otherdomain.tld
DocumentRoot /www/otherdomain-8080
&lt;/VirtualHost&gt;
</PRE></BLOCKQUOTE>
</UL>
<HR>
<H3><A NAME="ip">IP-based vhosts</A></H3>
<UL>
<LI><STRONG>Setup 1:</STRONG>
The server machine has two IP addresses (<SAMP>111.22.33.44</SAMP>
and <SAMP>111.22.33.55</SAMP>)
which resolve to the names <SAMP>server.domain.tld</SAMP> and
<SAMP>www.otherdomain.tld</SAMP> respectively.
The hostname <SAMP>www.domain.tld</SAMP> is an alias (CNAME)
for <SAMP>server.domain.tld</SAMP> and will represent the
main server.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
Listen 80
DocumentRoot /www/domain
ServerName www.domain.tld
&lt;VirtualHost 111.22.33.55&gt;
DocumentRoot /www/otherdomain
ServerName www.otherdomain.tld
...
&lt;/VirtualHost&gt;
</PRE>
<SAMP>www.otherdomain.tld</SAMP> can only be reached through the
address <SAMP>111.22.33.55</SAMP>, while <SAMP>www.domain.tld</SAMP>
can only be reached through <SAMP>111.22.33.44</SAMP>
(which represents our main server).
</BLOCKQUOTE>
<P>
<LI><STRONG>Setup 2:</STRONG>
Same as setup 1, but we don't want to have a dedicated main server.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
Listen 80
ServerName server.domain.tld
&lt;VirtualHost 111.22.33.44&gt;
DocumentRoot /www/domain
ServerName www.domain.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.55&gt;
DocumentRoot /www/otherdomain
ServerName www.otherdomain.tld
...
&lt;/VirtualHost&gt;
</PRE>
The main server can never catch a request, because all IP addresses
of our machine are in use for IP-based virtual hosts
(only <SAMP>localhost</SAMP> requests can hit the main server).
</BLOCKQUOTE>
<P>
<LI><STRONG>Setup 3:</STRONG>
The server machine has two IP addresses (<SAMP>111.22.33.44</SAMP>
and <SAMP>111.22.33.55</SAMP>)
which resolve to the names <SAMP>server.domain.tld</SAMP> and
<SAMP>www-cache.domain.tld</SAMP> respectively.
The hostname <SAMP>www.domain.tld</SAMP> is an alias (CNAME)
for <SAMP>server.domain.tld</SAMP> and will represent the
main server.
<SAMP>www-cache.domain.tld</SAMP> will become our proxy-cache
listening on port 8080, while the web server itself uses the default
port 80.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
Listen 111.22.33.44:80
Listen 111.22.33.55:8080
ServerName server.domain.tld
&lt;VirtualHost 111.22.33.44:80&gt;
DocumentRoot /www/domain
ServerName www.domain.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.55:8080&gt;
ServerName www-cache.domain.tld
...
&lt;Directory proxy:&gt;
Order Deny,Allow
Deny from all
Allow from 111.22.33
&lt;/Directory&gt;
&lt;/VirtualHost&gt;
</PRE>
The main server can never catch a request, because all IP addresses
(apart from <SAMP>localhost</SAMP>) of our machine are in use for IP-based
virtual hosts. The web server can only be reached on the first address
through port 80 and the proxy only on the second address through port 8080.
</BLOCKQUOTE>
</UL>
<HR>
<H3><A NAME="mixed">Mixed name-/IP-based vhosts</A></H3>
<UL>
<LI><STRONG>Setup:</STRONG>
The server machine has three IP addresses (<SAMP>111.22.33.44</SAMP>,
<SAMP>111.22.33.55</SAMP> and <SAMP>111.22.33.66</SAMP>)
which resolve to the names <SAMP>server.domain.tld</SAMP>,
<SAMP>www.otherdomain1.tld</SAMP> and <SAMP>www.otherdomain2.tld</SAMP>
respectively.
The address <SAMP>111.22.33.44</SAMP> should be used for a couple
of name-based vhosts and the other addresses for IP-based vhosts.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
Listen 80
ServerName server.domain.tld
NameVirtualHost 111.22.33.44
&lt;VirtualHost 111.22.33.44&gt;
DocumentRoot /www/domain
ServerName www.domain.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.44&gt;
DocumentRoot /www/subdomain1
ServerName www.sub1.domain.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.44&gt;
DocumentRoot /www/subdomain2
ServerName www.sub2.domain.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.55&gt;
DocumentRoot /www/otherdomain1
ServerName www.otherdomain1.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.66&gt;
DocumentRoot /www/otherdomain2
ServerName www.otherdomain2.tld
...
&lt;/VirtualHost&gt;
</PRE></BLOCKQUOTE>
</UL>
<HR>
<H3><A NAME="port">Port-based vhosts</A></H3>
<UL>
<LI><STRONG>Setup:</STRONG>
The server machine has one IP address (<SAMP>111.22.33.44</SAMP>)
which resolves to the name <SAMP>www.domain.tld</SAMP>.
If we don't have the option to get another address or alias
for our server we can use port-based vhosts if we need
a virtual host with a different configuration.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
Listen 80
Listen 8080
ServerName www.domain.tld
DocumentRoot /www/domain
&lt;VirtualHost 111.22.33.44:8080&gt;
DocumentRoot /www/domain2
...
&lt;/VirtualHost&gt;
</PRE>
A request to <SAMP>www.domain.tld</SAMP> on port 80 is served
from the main server and a request to port 8080 is served from
the virtual host.
</BLOCKQUOTE>
</UL>
<HR>
<H3><A NAME="default">Using <CODE>_default_</CODE> vhosts</A></H3>
<UL>
<LI><STRONG>Setup 1:</STRONG>
Catching <EM>every</EM> request to any unspecified IP address and port,
<EM>i.e.</EM>, an address/port combination that is not used for any other
virtual host.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
&lt;VirtualHost _default_:*&gt;
DocumentRoot /www/default
...
&lt;/VirtualHost&gt;
</PRE>
Using such a default vhost with a wildcard port effectively
prevents any request going to the main server.<BR>
A default vhost never serves a request that was sent to an
address/port that is used for name-based vhosts. If the request
contained an unknown or no <CODE>Host:</CODE> header it is
always served from the primary name-based vhost (the
vhost for that address/port appearing first in the configuration
file).<BR>
You can use
<A HREF="/mod/mod_alias.html#aliasmatch"><CODE>AliasMatch</CODE></A>
or
<A HREF="/mod/mod_rewrite.html#RewriteRule"><CODE>RewriteRule</CODE></A>
to rewrite any request to a single information page (or script).
</BLOCKQUOTE>
<P>
<LI><STRONG>Setup 2:</STRONG>
Same as setup 1, but the server listens on several ports and
we want to use a second <CODE>_default_</CODE> vhost for port 80.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
&lt;VirtualHost _default_:80&gt;
DocumentRoot /www/default80
...
&lt;/VirtualHost&gt;
&lt;VirtualHost _default_:*&gt;
DocumentRoot /www/default
...
&lt;/VirtualHost&gt;
</PRE>
The default vhost for port 80 (which <EM>must</EM> appear before
any default vhost with a wildcard port) catches all requests that
were sent to an unspecified IP address. The main server is
never used to serve a request.
</BLOCKQUOTE>
<P>
<LI><STRONG>Setup 3:</STRONG>
We want to have a default vhost for port 80, but no other default vhosts.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
&lt;VirtualHost _default_:80&gt;
DocumentRoot /www/default
...
&lt;/VirtualHost&gt;
</PRE>
A request to an unspecified address on port 80 is served from the
default vhost any other request to an unspecified address and port
is served from the main server.
</BLOCKQUOTE>
</UL>
<HR>
<H3><A NAME="migrate">Migrating a name-based vhost to an IP-based vhost</A></H3>
<UL>
<LI><STRONG>Setup:</STRONG>
The name-based vhost with the hostname
<SAMP>www.otherdomain.tld</SAMP> (from our <A HREF="#name">name-based</A>
example, setup 2) should get its own IP address.
To avoid problems with name servers or proxies who cached the old
IP address for the name-based vhost we want to provide both variants
during a migration phase.<BR>
The solution is easy, because we can simply add the new IP address
(<SAMP>111.22.33.66</SAMP>) to the <CODE>VirtualHost</CODE> directive.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
Listen 80
ServerName www.domain.tld
DocumentRoot /www/domain
NameVirtualHost 111.22.33.55
&lt;VirtualHost 111.22.33.55 111.22.33.66&gt;
DocumentRoot /www/otherdomain
ServerName www.otherdomain.tld
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.55&gt;
DocumentRoot /www/subdomain
ServerName www.sub.domain.tld
ServerAlias *.sub.domain.tld
...
&lt;/VirtualHost&gt;
</PRE>
The vhost can now be accessed through the new address (as an IP-based
vhost) and through the old address (as a name-based vhost).
</BLOCKQUOTE>
</UL>
<HR>
<H3><A NAME="serverpath">Using the <CODE>ServerPath</CODE> directive</A></H3>
<UL>
<LI><STRONG>Setup:</STRONG>
We have a server with two name-based vhosts. In order to match the correct
virtual host a client must send the correct <CODE>Host:</CODE> header.
Old HTTP/1.0 clients do not send such a header and Apache has no clue
what vhost the client tried to reach (and serves the request from
the primary vhost). To provide as much backward compatibility
as possible we create a primary vhost which returns a single page
containing links with an URL prefix to the name-based virtual hosts.
<P>
<STRONG>Server configuration:</STRONG>
<BLOCKQUOTE><PRE>
...
NameVirtualHost 111.22.33.44
&lt;VirtualHost 111.22.33.44&gt;
# primary vhost
DocumentRoot /www/subdomain
RewriteEngine On
RewriteRule ^/.* /www/subdomain/index.html
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.44&gt;
DocumentRoot /www/subdomain/sub1
ServerName www.sub1.domain.tld
ServerPath /sub1/
RewriteEngine On
RewriteRule ^(/sub1/.*) /www/subdomain$1
...
&lt;/VirtualHost&gt;
&lt;VirtualHost 111.22.33.44&gt;
DocumentRoot /www/subdomain/sub2
ServerName www.sub2.domain.tld
ServerPath /sub2/
RewriteEngine On
RewriteRule ^(/sub2/.*) /www/subdomain$1
...
&lt;/VirtualHost&gt;
</PRE>
Due to the <A HREF="/mod/core.html#serverpath"><CODE>ServerPath</CODE></A>
directive a request to the
URL <SAMP>http://www.sub1.domain.tld/sub1/</SAMP> is <EM>always</EM>
served from the sub1-vhost. <BR>
A request to the URL <SAMP>http://www.sub1.domain.tld/</SAMP>
is only served from the sub1-vhost if the client sent a correct
<CODE>Host:</CODE> header.
If no <CODE>Host:</CODE> header is sent the client gets the
information page from the primary host.<BR>
Please note that there is one oddity: A request to
<SAMP>http://www.sub2.domain.tld/sub1/</SAMP> is also served from
the sub1-vhost if the client sent no <CODE>Host:</CODE> header. <BR>
The <CODE>RewriteRule</CODE> directives are used to make sure that
a client which sent a correct <CODE>Host:</CODE> header can use
both URL variants, <EM>i.e.</EM>, with or without URL prefix.
</BLOCKQUOTE>
</UL>
<LI><STRONG>Setup:</STRONG>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>