home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 May / PCWorld_2003-05_cd.bin / Komunik / apache / apache_2.0.45-win32-x86-no_ssl.msi / Data.Cab / F233100_namebased.xml < prev    next >
Extensible Markup Language  |  2002-11-18  |  11KB  |  253 lines
  1. <?xml version='1.0' encoding='UTF-8' ?>
  2. <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4.  
  5. <manualpage>
  6. <relativepath href=".."/>
  7. <parentdocument href="./">Virtual Hosts</parentdocument>
  8. <title>Name-based Virtual Host Support</title>
  9.  
  10. <summary>
  11.  
  12.     <p>This document describes when and how to use name-based virtual hosts.</p>
  13.  
  14. </summary>
  15.  
  16. <seealso><a href="ip-based.html">IP-based Virtual Host Support</a></seealso>
  17. <seealso><a href="details.html">An In-Depth Discussion of Virtual Host Matching</a></seealso>
  18. <seealso><a href="mass.html">Dynamically configured mass virtual hosting</a></seealso>
  19. <seealso><a href="examples.html">Virtual Host examples for common setups</a></seealso>
  20. <seealso><a href="examples.html#serverpath">ServerPath configuration example</a></seealso>
  21.  
  22. <section id="namevip"><title>Name-based vs. IP-based Virtual Hosts</title>
  23.  
  24.     <p>IP-based virtual hosts use the IP address of the connection to
  25.     determine the correct virtual host to serve.  Therefore you need to
  26.     have a separate IP address for each host.  With name-based virtual
  27.     hosting, the server relies on the client to report the hostname as
  28.     part of the HTTP headers.  Using this technique, many different hosts
  29.     can share the same IP address.</p>
  30.  
  31.     <p>Name-based virtual hosting is usually simpler, since you need
  32.     only configure your DNS server to map each hostname to the correct
  33.     IP address and then configure the Apache HTTP Server to recognize
  34.     the different hostnames.  Name-based virtual hosting also eases
  35.     the demand for scarce IP addresses.  Therefore you should use
  36.     name-based virtual hosting unless there is a specific reason to
  37.     choose IP-based virtual hosting.  Some reasons why you might consider
  38.     using IP-based virtual hosting:</p>
  39.  
  40.     <ul>
  41.         <li>Some ancient clients are not compatible with name-based virtual
  42.         hosting.  For name-based virtual hosting to work, the client must send
  43.         the HTTP Host header.  This is required by HTTP/1.1, and is
  44.         implemented by all modern HTTP/1.0 browsers as an extension.  If you
  45.         need to support obsolete clients and still use name-based virtual
  46.         hosting, a possible technique is discussed at the end of this
  47.         document.</li>
  48.  
  49.         <li>Name-based virtual hosting cannot be used with SSL secure servers
  50.         because of the nature of the SSL protocol.</li>
  51.  
  52.         <li>Some operating systems and network equipment implement bandwidth
  53.         management techniques that cannot differentiate between hosts unless
  54.         they are on separate IP addresses.</li>
  55.     </ul>
  56.  
  57. </section>
  58.  
  59. <section id="using"><title>Using Name-based Virtual Hosts</title>
  60.  
  61. <related>
  62.     <modulelist>
  63.     <module>core</module>
  64.     </modulelist>
  65.  
  66.     <directivelist>
  67.     <directive module="core">DocumentRoot</directive>
  68.     <directive module="core">NameVirtualHost</directive>
  69.     <directive module="core">ServerAlias</directive>
  70.     <directive module="core">ServerName</directive>
  71.     <directive module="core">ServerPath</directive>
  72.     <directive module="core">VirtualHost</directive>
  73.     </directivelist>
  74. </related>
  75.  
  76.     <p>To use name-based virtual hosting, you must designate the IP
  77.     address (and possibly port) on the server that will be accepting
  78.     requests for the hosts.  This is configured using the <directive
  79.     module="core">NameVirtualHost</directive> directive.
  80.     In the normal case where any and all IP addresses on the server should
  81.     be used, you can use <code>*</code> as the argument to
  82.     <code>NameVirtualHost</code>.  Note that mentioning an IP address in a
  83.     <code>NameVirtualHost</code> directive does not automatically make the
  84.     server listen to that IP address.  See <a href="../bind.html">Setting
  85.     which addresses and ports Apache uses</a> for more details.  In addition,
  86.     any IP address specified here must be associated with a network interface
  87.     on the server.</p>
  88.  
  89.     <p>The next step is to create a <directive type="section"
  90.     module="core">VirtualHost</directive> block for
  91.     each different host that you would like to serve.  The argument to the
  92.     <code><VirtualHost></code> directive should be the same as the
  93.     argument to the <code>NameVirtualHost</code> directive (ie, an IP
  94.     address, or <code>*</code> for all addresses).  Inside each
  95.     <code><VirtualHost></code> block, you will need at minimum a
  96.     <directive module="core">ServerName</directive> directive to
  97.     designate which host is served and a <directive
  98.     module="core">DocumentRoot</directive> directive to
  99.     show where in the filesystem the content for that host lives.</p>
  100.  
  101.     <note><title>Main host goes away</title>
  102.     If you are adding virtual hosts to an existing web server, you
  103.     must also create a <VirtualHost> block for the existing host.
  104.     The <code>ServerName</code> and <code>DocumentRoot</code> included in
  105.     this virtual host should be the same as the global
  106.     <code>ServerName</code> and <code>DocumentRoot</code>.  List this
  107.     virtual host first in the configuration file so that it will act as
  108.     the default host.
  109.     </note>
  110.  
  111.     <p>For example, suppose that you are serving the domain
  112.     <code>www.domain.tld</code> and you wish to add the virtual host
  113.     <code>www.otherdomain.tld</code>, which points at the same IP address.
  114.     Then you simply add the following to <code>httpd.conf</code>:</p>
  115.  
  116.     <example>
  117.     NameVirtualHost *<br />
  118.     <br />
  119.     <VirtualHost *><br />
  120.     <indent>
  121.     ServerName www.domain.tld<br />
  122.     ServerAlias domain.tld *.domain.tld<br />
  123.     DocumentRoot /www/domain<br />
  124.     </indent>
  125.     </VirtualHost><br />
  126.     <br />
  127.     <VirtualHost *><br />
  128.     <indent>ServerName www.otherdomain.tld<br />
  129.     DocumentRoot /www/otherdomain<br />
  130.     </indent>
  131.     </VirtualHost><br />
  132.     </example>
  133.  
  134.     <p>You can alternatively specify an explicit IP address in place of
  135.     the * in both the <code>NameVirtualHost</code> and
  136.     <code><VirtualHost></code> directives. For example, you might
  137.     want to do this in order to run some name-based virtual hosts on one
  138.     IP address, and either IP-based, or another set of name-based
  139.     virtual hosts on another address.</p>
  140.  
  141.     <p>Many servers want to be accessible by more than one name.  This is
  142.     possible with the <directive module="core">ServerAlias</directive>
  143.     directive, placed inside the <VirtualHost> section. For
  144.     example in the first <VirtualHost> block above, the <directive
  145.     module="core">ServerAlias</directive> directive indicates that the
  146.     listed names are other names which people can use to see that same
  147.     web site:</p>
  148.  
  149.     <example>
  150.     ServerAlias domain.tld *.domain.tld
  151.     </example>
  152.  
  153.     <p>then requests for all hosts in the <code>domain.tld</code> domain
  154.     will be served by the <code>www.domain.tld</code> virtual host.  The
  155.     wildcard characters * and ? can be used to match names.  Of course,
  156.     you can't just make up names and place them in <code>ServerName</code>
  157.     or <code>ServerAlias</code>.  You must first have your DNS server
  158.     properly configured to map those names to an IP address associated
  159.     with your server.</p>
  160.  
  161.     <p>Finally, you can fine-tune the configuration of the virtual hosts
  162.     by placing other directives inside the
  163.     <code><VirtualHost></code> containers.  Most directives can be
  164.     placed in these containers and will then change the configuration only
  165.     of the relevant virtual host.  To find out if a particular directive
  166.     is allowed, check the <a
  167.     href="../mod/directive-dict.html#Context">Context</a> of the
  168.     directive.  Configuration directives set in the <em>main server
  169.     context</em> (outside any <code><VirtualHost></code> container)
  170.     will be used only if they are not overriden by the virtual host
  171.     settings.</p>
  172.  
  173.     <p>Now when a request arrives, the server will first check if it is
  174.     using an IP address that matches the <code>NameVirtualHost</code>.  If
  175.     it is, then it will look at each <code><VirtualHost></code>
  176.     section with a matching IP address and try to find one where the
  177.     <code>ServerName</code> or <code>ServerAlias</code> matches the
  178.     requested hostname.  If it finds one, then it uses the configuration
  179.     for that server.  If no matching virtual host is found, then
  180.     <strong>the first listed virtual host</strong> that matches the IP
  181.     address will be used.</p>
  182.  
  183.     <p>As a consequence, the first listed virtual host is the
  184.     <em>default</em> virtual host.  The <code>DocumentRoot</code> from the
  185.     <em>main server</em> will <strong>never</strong> be used when an IP
  186.     address matches the <code>NameVirtualHost</code> directive.  If you
  187.     would like to have a special configuration for requests that do not
  188.     match any particular virtual host, simply put that configuration in a
  189.     <code><VirtualHost></code> container and list it first in the
  190.     configuration file.</p>
  191.  
  192. </section>
  193.  
  194. <section id="compat"><title>Compatibility with Older Browsers</title>
  195.  
  196.     <p>As mentioned earlier, there are some clients
  197.     who do not send the required data for the name-based virtual
  198.     hosts to work properly. These clients will always be sent the
  199.     pages from the first virtual host listed for that IP address
  200.     (the <cite>primary</cite> name-based virtual host).</p>
  201.  
  202.     <note><title>How much older?</title>
  203.     Please note that when we say older, we really do mean older. You are
  204.     very unlikely to encounter one of these browsers in use today. All
  205.     current versions of any browser send the <code>Host</code> header as
  206.     required for name-based virtual hosts.
  207.     </note>
  208.  
  209.     <p>There is a possible workaround with the <directive
  210.     module="core">ServerPath</directive>
  211.     directive, albeit a slightly cumbersome one:</p>
  212.  
  213.     <p>Example configuration:</p>
  214.  
  215.     <example>
  216.     NameVirtualHost 111.22.33.44<br />
  217.     <br />
  218.     <VirtualHost 111.22.33.44><br />
  219.     <indent>
  220.     ServerName www.domain.tld<br />
  221.     ServerPath /domain<br />
  222.     DocumentRoot /web/domain<br />
  223.     </indent>
  224.     </VirtualHost><br />
  225.        </example>
  226.  
  227.     <p>What does this mean? It means that a request for any URI
  228.     beginning with "<code>/domain</code>" will be served from the
  229.     virtual host <code>www.domain.tld</code> This means that the
  230.     pages can be accessed as
  231.     <code>http://www.domain.tld/domain/</code> for all clients,
  232.     although clients sending a <code>Host:</code> header can also
  233.     access it as <code>http://www.domain.tld/</code>.</p>
  234.  
  235.     <p>In order to make this work, put a link on your primary
  236.     virtual host's page to
  237.     <code>http://www.domain.tld/domain/</code> Then, in the virtual
  238.     host's pages, be sure to use either purely relative links
  239.     (<em>e.g.</em>, "<code>file.html</code>" or
  240.     "<code>../icons/image.gif</code>" or links containing the
  241.     prefacing <code>/domain/</code> (<em>e.g.</em>,
  242.     "<code>http://www.domain.tld/domain/misc/file.html</code>" or
  243.     "<code>/domain/misc/file.html</code>").</p>
  244.  
  245.     <p>This requires a bit of discipline, but adherence to these
  246.     guidelines will, for the most part, ensure that your pages will
  247.     work with all browsers, new and old.</p>
  248.  
  249. </section>
  250. </manualpage>
  251.  
  252.  
  253.