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 / F233089_mass.html.en < prev    next >
Extensible Markup Language  |  2003-03-30  |  21KB  |  437 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>Dynamically configured mass virtual hosting - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body id="manual-page"><div id="page-header">
  14. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  15. <p class="apache">Apache HTTP Server Version 2.0</p>
  16. <img alt="" src="../images/feather.gif" /></div>
  17. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  18. <div id="path">
  19. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Virtual Hosts</a></div><div id="page-content"><div id="preamble"><h1>Dynamically configured mass virtual hosting</h1>
  20.  
  21.     <p>This document describes how to efficiently serve an
  22.     arbitrary number of virtual hosts with Apache 1.3. 
  23.     </p>
  24.  
  25. </div>
  26. <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#motivation">Motivation</a></li>
  27. <li><img alt="" src="../images/down.gif" /> <a href="#overview">Overview</a></li>
  28. <li><img alt="" src="../images/down.gif" /> <a href="#simple">Simple dynamic virtual hosts</a></li>
  29. <li><img alt="" src="../images/down.gif" /> <a href="#homepages">A virtually hosted homepages system</a></li>
  30. <li><img alt="" src="../images/down.gif" /> <a href="#combinations">Using more than
  31.     one virtual hosting system on the same server</a></li>
  32. <li><img alt="" src="../images/down.gif" /> <a href="#ipbased">More efficient IP-based virtual hosting</a></li>
  33. <li><img alt="" src="../images/down.gif" /> <a href="#oldversion">Using older versions of Apache</a></li>
  34. <li><img alt="" src="../images/down.gif" /> <a href="#simple.rewrite">Simple dynamic
  35.     virtual hosts using <code>mod_rewrite</code></a></li>
  36. <li><img alt="" src="../images/down.gif" /> <a href="#homepages.rewrite">A
  37.     homepages system using <code>mod_rewrite</code></a></li>
  38. <li><img alt="" src="../images/down.gif" /> <a href="#xtra-conf">Using a separate virtual
  39.     host configuration file</a></li>
  40. </ul></div>
  41. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  42. <div class="section">
  43. <h2><a name="motivation" id="motivation">Motivation</a></h2>
  44.  
  45.     <p>The techniques described here are of interest if your
  46.     <code>httpd.conf</code> contains many
  47.     <code><VirtualHost></code> sections that are
  48.     substantially the same, for example:</p>
  49.  
  50. <div class="example"><p><code>
  51. NameVirtualHost 111.22.33.44<br />
  52. <VirtualHost 111.22.33.44><br />
  53. <span class="indent">
  54.     ServerName                 www.customer-1.com<br />
  55.     DocumentRoot        /www/hosts/www.customer-1.com/docs<br />
  56.     ScriptAlias  /cgi-bin/  /www/hosts/www.customer-1.com/cgi-bin<br />
  57. </span>
  58. </VirtualHost><br />
  59. <VirtualHost 111.22.33.44><br />
  60. <span class="indent">
  61.     ServerName                 www.customer-2.com<br />
  62.     DocumentRoot        /www/hosts/www.customer-2.com/docs<br />
  63.     ScriptAlias  /cgi-bin/  /www/hosts/www.customer-2.com/cgi-bin<br />
  64. </span>
  65. </VirtualHost><br />
  66. # blah blah blah<br />
  67. <VirtualHost 111.22.33.44><br />
  68. <span class="indent">
  69.     ServerName                 www.customer-N.com<br />
  70.     DocumentRoot        /www/hosts/www.customer-N.com/docs<br />
  71.     ScriptAlias  /cgi-bin/  /www/hosts/www.customer-N.com/cgi-bin<br />
  72. </span>
  73. </VirtualHost>
  74. </code></p></div>
  75.  
  76.     <p>The basic idea is to replace all of the static
  77.     <code><VirtualHost></code> configuration with a mechanism
  78.     that works it out dynamically. This has a number of
  79.     advantages:</p>
  80.  
  81.     <ol>
  82.       <li>Your configuration file is smaller so Apache starts
  83.       faster and uses less memory.</li>
  84.  
  85.       <li>Adding virtual hosts is simply a matter of creating the
  86.       appropriate directories in the filesystem and entries in the
  87.       DNS - you don't need to reconfigure or restart Apache.</li>
  88.     </ol>
  89.  
  90.     <p>The main disadvantage is that you cannot have a different
  91.     log file for each virtual host; however if you have very many
  92.     virtual hosts then doing this is dubious anyway because it eats
  93.     file descriptors. It is better to log to a pipe or a fifo and
  94.     arrange for the process at the other end to distribute the logs
  95.     to the customers (it can also accumulate statistics, etc.).</p>
  96.  
  97. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  98. <div class="section">
  99. <h2><a name="overview" id="overview">Overview</a></h2>
  100.  
  101.     <p>A virtual host is defined by two pieces of information: its
  102.     IP address, and the contents of the <code>Host:</code> header
  103.     in the HTTP request. The dynamic mass virtual hosting technique
  104.     is based on automatically inserting this information into the
  105.     pathname of the file that is used to satisfy the request. This
  106.     is done most easily using <code class="module"><a href="../mod/mod_vhost_alias.html">mod_vhost_alias</a></code>,
  107.     but if you are using a version of Apache up to 1.3.6 then you
  108.     must use <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>.
  109.     Both of these modules are disabled by default; you must enable
  110.     one of them when configuring and building Apache if you want to
  111.     use this technique.</p>
  112.  
  113.     <p>A couple of things need to be `faked' to make the dynamic
  114.     virtual host look like a normal one. The most important is the
  115.     server name which is used by Apache to generate
  116.     self-referential URLs, etc. It is configured with the
  117.     <code>ServerName</code> directive, and it is available to CGIs
  118.     via the <code>SERVER_NAME</code> environment variable. The
  119.     actual value used at run time is controlled by the <code class="directive"><a href="../mod/core.html#usecanonicalname">UseCanonicalName</a></code>
  120.     setting. With <code>UseCanonicalName Off</code> the server name
  121.     comes from the contents of the <code>Host:</code> header in the
  122.     request. With <code>UseCanonicalName DNS</code> it comes from a
  123.     reverse DNS lookup of the virtual host's IP address. The former
  124.     setting is used for name-based dynamic virtual hosting, and the
  125.     latter is used for IP-based hosting. If Apache cannot work out
  126.     the server name because there is no <code>Host:</code> header
  127.     or the DNS lookup fails then the value configured with
  128.     <code>ServerName</code> is used instead.</p>
  129.  
  130.     <p>The other thing to `fake' is the document root (configured
  131.     with <code>DocumentRoot</code> and available to CGIs via the
  132.     <code>DOCUMENT_ROOT</code> environment variable). In a normal
  133.     configuration this setting is used by the core module when
  134.     mapping URIs to filenames, but when the server is configured to
  135.     do dynamic virtual hosting that job is taken over by another
  136.     module (either <code>mod_vhost_alias</code> or
  137.     <code>mod_rewrite</code>) which has a different way of doing
  138.     the mapping. Neither of these modules is responsible for
  139.     setting the <code>DOCUMENT_ROOT</code> environment variable so
  140.     if any CGIs or SSI documents make use of it they will get a
  141.     misleading value.</p>
  142.  
  143. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  144. <div class="section">
  145. <h2><a name="simple" id="simple">Simple dynamic virtual hosts</a></h2>
  146.  
  147.     <p>This extract from <code>httpd.conf</code> implements the
  148.     virtual host arrangement outlined in the <a href="#motivation">Motivation</a> section above, but in a
  149.     generic fashion using <code>mod_vhost_alias</code>.</p>
  150.  
  151. <div class="example"><p><code>
  152. # get the server name from the Host: header<br />
  153. UseCanonicalName Off<br />
  154. <br />
  155. # this log format can be split per-virtual-host based on the first field<br />
  156. LogFormat "%V %h %l %u %t \"%r\" %s %b" vcommon<br />
  157. CustomLog logs/access_log vcommon<br />
  158. <br />
  159. # include the server name in the filenames used to satisfy requests<br />
  160. VirtualDocumentRoot /www/hosts/%0/docs<br />
  161. VirtualScriptAlias  /www/hosts/%0/cgi-bin
  162. </code></p></div>
  163.  
  164.     <p>This configuration can be changed into an IP-based virtual
  165.     hosting solution by just turning <code>UseCanonicalName
  166.     Off</code> into <code>UseCanonicalName DNS</code>. The server
  167.     name that is inserted into the filename is then derived from
  168.     the IP address of the virtual host.</p>
  169.  
  170. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  171. <div class="section">
  172. <h2><a name="homepages" id="homepages">A virtually hosted homepages system</a></h2>
  173.  
  174.     <p>This is an adjustment of the above system tailored for an
  175.     ISP's homepages server. Using a slightly more complicated
  176.     configuration we can select substrings of the server name to
  177.     use in the filename so that e.g. the documents for
  178.     <code>www.user.isp.com</code> are found in
  179.     <code>/home/user/</code>. It uses a single <code>cgi-bin</code>
  180.     directory instead of one per virtual host.</p>
  181.  
  182. <div class="example"><p><code>
  183. # all the preliminary stuff is the same as above, then<br />
  184. <br />
  185. # include part of the server name in the filenames<br />
  186. VirtualDocumentRoot /www/hosts/%2/docs<br />
  187. <br />
  188. # single cgi-bin directory<br />
  189. ScriptAlias  /cgi-bin/  /www/std-cgi/<br />
  190. </code></p></div>
  191.  
  192.     <p>There are examples of more complicated
  193.     <code>VirtualDocumentRoot</code> settings in the
  194.     <code class="module"><a href="../mod/mod_vhost_alias.html">mod_vhost_alias</a></code> documentation.</p>
  195.  
  196. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  197. <div class="section">
  198. <h2><a name="combinations" id="combinations">Using more than
  199.     one virtual hosting system on the same server</a></h2>
  200.  
  201.     <p>With more complicated setups you can use Apache's normal
  202.     <code><VirtualHost></code> directives to control the
  203.     scope of the various virtual hosting configurations. For
  204.     example, you could have one IP address for homepages customers
  205.     and another for commercial customers with the following setup.
  206.     This can of course be combined with conventional
  207.     <code><VirtualHost></code> configuration sections.</p>
  208.  
  209. <div class="example"><p><code>
  210. UseCanonicalName Off<br />
  211. <br />
  212. LogFormat "%V %h %l %u %t \"%r\" %s %b" vcommon<br />
  213. <br />
  214. <Directory /www/commercial><br />
  215. <span class="indent">
  216.     Options FollowSymLinks<br />
  217.     AllowOverride All<br />
  218. </span>
  219. </Directory><br />
  220. <br />
  221. <Directory /www/homepages><br />
  222. <span class="indent">
  223.     Options FollowSymLinks<br />
  224.     AllowOverride None<br />
  225. </span>
  226. </Directory><br />
  227. <br />
  228. <VirtualHost 111.22.33.44><br />
  229. <span class="indent">
  230.     ServerName www.commercial.isp.com<br />
  231.     <br />
  232.     CustomLog logs/access_log.commercial vcommon<br />
  233.     <br />
  234.     VirtualDocumentRoot /www/commercial/%0/docs<br />
  235.     VirtualScriptAlias  /www/commercial/%0/cgi-bin<br />
  236. </span>
  237. </VirtualHost><br />
  238. <br />
  239. <VirtualHost 111.22.33.45><br />
  240. <span class="indent">
  241.     ServerName www.homepages.isp.com<br />
  242.     <br />
  243.     CustomLog logs/access_log.homepages vcommon<br />
  244.     <br />
  245.     VirtualDocumentRoot /www/homepages/%0/docs<br />
  246.     ScriptAlias         /cgi-bin/ /www/std-cgi/<br />
  247. </span>
  248. </VirtualHost>
  249. </code></p></div>
  250.  
  251. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  252. <div class="section">
  253. <h2><a name="ipbased" id="ipbased">More efficient IP-based virtual hosting</a></h2>
  254.  
  255.     <p>After <a href="#simple">the first example</a> I noted that
  256.     it is easy to turn it into an IP-based virtual hosting setup.
  257.     Unfortunately that configuration is not very efficient because
  258.     it requires a DNS lookup for every request. This can be avoided
  259.     by laying out the filesystem according to the IP addresses
  260.     themselves rather than the corresponding names and changing the
  261.     logging similarly. Apache will then usually not need to work
  262.     out the server name and so incur a DNS lookup.</p>
  263.  
  264. <div class="example"><p><code>
  265. # get the server name from the reverse DNS of the IP address<br />
  266. UseCanonicalName DNS<br />
  267. <br />
  268. # include the IP address in the logs so they may be split<br />
  269. LogFormat "%A %h %l %u %t \"%r\" %s %b" vcommon<br />
  270. CustomLog logs/access_log vcommon<br />
  271. <br />
  272. # include the IP address in the filenames<br />
  273. VirtualDocumentRootIP /www/hosts/%0/docs<br />
  274. VirtualScriptAliasIP  /www/hosts/%0/cgi-bin<br />
  275. </code></p></div>
  276.  
  277. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  278. <div class="section">
  279. <h2><a name="oldversion" id="oldversion">Using older versions of Apache</a></h2>
  280.  
  281.     <p>The examples above rely on <code>mod_vhost_alias</code>
  282.     which appeared after version 1.3.6. If you are using a version
  283.     of Apache without <code>mod_vhost_alias</code> then you can
  284.     implement this technique with <code>mod_rewrite</code> as
  285.     illustrated below, but only for Host:-header-based virtual
  286.     hosts.</p>
  287.  
  288.     <p>In addition there are some things to beware of with logging.
  289.     Apache 1.3.6 is the first version to include the
  290.     <code>%V</code> log format directive; in versions 1.3.0 - 1.3.3
  291.     the <code>%v</code> option did what <code>%V</code> does;
  292.     version 1.3.4 has no equivalent. In all these versions of
  293.     Apache the <code>UseCanonicalName</code> directive can appear
  294.     in <code>.htaccess</code> files which means that customers can
  295.     cause the wrong thing to be logged. Therefore the best thing to
  296.     do is use the <code>%{Host}i</code> directive which logs the
  297.     <code>Host:</code> header directly; note that this may include
  298.     <code>:port</code> on the end which is not the case for
  299.     <code>%V</code>.</p>
  300.  
  301. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  302. <div class="section">
  303. <h2><a name="simple.rewrite" id="simple.rewrite">Simple dynamic
  304.     virtual hosts using <code>mod_rewrite</code></a></h2>
  305.  
  306.     <p>This extract from <code>httpd.conf</code> does the same
  307.     thing as <a href="#simple">the first example</a>. The first
  308.     half is very similar to the corresponding part above but with
  309.     some changes for backward compatibility and to make the
  310.     <code>mod_rewrite</code> part work properly; the second half
  311.     configures <code>mod_rewrite</code> to do the actual work.</p>
  312.  
  313.     <p>There are a couple of especially tricky bits: By default,
  314.     <code>mod_rewrite</code> runs before the other URI translation
  315.     modules (<code>mod_alias</code> etc.) so if they are used then
  316.     <code>mod_rewrite</code> must be configured to accommodate
  317.     them. Also, mome magic must be performed to do a
  318.     per-dynamic-virtual-host equivalent of
  319.     <code>ScriptAlias</code>.</p>
  320.  
  321. <div class="example"><p><code>
  322. # get the server name from the Host: header<br />
  323. UseCanonicalName Off<br />
  324. <br />
  325. # splittable logs<br />
  326. LogFormat "%{Host}i %h %l %u %t \"%r\" %s %b" vcommon<br />
  327. CustomLog logs/access_log vcommon<br />
  328. <br />
  329. <Directory /www/hosts><br />
  330. <span class="indent">
  331.     # ExecCGI is needed here because we can't force<br />
  332.     # CGI execution in the way that ScriptAlias does<br />
  333.     Options FollowSymLinks ExecCGI<br />
  334. </span>
  335. </Directory><br />
  336. <br />
  337. # now for the hard bit<br />
  338. <br />
  339. RewriteEngine On<br />
  340. <br />
  341. # a ServerName derived from a Host: header may be any case at all<br />
  342. RewriteMap  lowercase  int:tolower<br />
  343. <br />
  344. ## deal with normal documents first:<br />
  345. # allow Alias /icons/ to work - repeat for other aliases<br />
  346. RewriteCond  %{REQUEST_URI}  !^/icons/<br />
  347. # allow CGIs to work<br />
  348. RewriteCond  %{REQUEST_URI}  !^/cgi-bin/<br />
  349. # do the magic<br />
  350. RewriteRule  ^/(.*)$  /www/hosts/${lowercase:%{SERVER_NAME}}/docs/$1<br />
  351. <br />
  352. ## and now deal with CGIs - we have to force a MIME type<br />
  353. RewriteCond  %{REQUEST_URI}  ^/cgi-bin/<br />
  354. RewriteRule  ^/(.*)$  /www/hosts/${lowercase:%{SERVER_NAME}}/cgi-bin/$1  [T=application/x-httpd-cgi]<br />
  355. <br />
  356. # that's it!
  357. </code></p></div>
  358.  
  359. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  360. <div class="section">
  361. <h2><a name="homepages.rewrite" id="homepages.rewrite">A
  362.     homepages system using <code>mod_rewrite</code></a></h2>
  363.  
  364.     <p>This does the same thing as <a href="#homepages">the second
  365.     example</a>.</p>
  366.  
  367. <div class="example"><p><code>
  368. RewriteEngine on<br />
  369. <br />
  370. RewriteMap   lowercase  int:tolower<br />
  371. <br />
  372. # allow CGIs to work<br />
  373. RewriteCond  %{REQUEST_URI}  !^/cgi-bin/<br />
  374. <br />
  375. # check the hostname is right so that the RewriteRule works<br />
  376. RewriteCond  ${lowercase:%{SERVER_NAME}}  ^www\.[a-z-]+\.isp\.com$<br />
  377. <br />
  378. # concatenate the virtual host name onto the start of the URI<br />
  379. # the [C] means do the next rewrite on the result of this one<br />
  380. RewriteRule  ^(.+)  ${lowercase:%{SERVER_NAME}}$1  [C]<br />
  381. <br />
  382. # now create the real file name<br />
  383. RewriteRule  ^www\.([a-z-]+)\.isp\.com/(.*) /home/$1/$2<br />
  384. <br />
  385. # define the global CGI directory<br />
  386. ScriptAlias  /cgi-bin/  /www/std-cgi/
  387. </code></p></div>
  388.  
  389. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  390. <div class="section">
  391. <h2><a name="xtra-conf" id="xtra-conf">Using a separate virtual
  392.     host configuration file</a></h2>
  393.  
  394.     <p>This arrangement uses more advanced <code>mod_rewrite</code>
  395.     features to get the translation from virtual host to document
  396.     root from a separate configuration file. This provides more
  397.     flexibility but requires more complicated configuration.</p>
  398.  
  399.     <p>The <code>vhost.map</code> file contains something like
  400.     this:</p>
  401.  
  402. <div class="example"><p><code>
  403. www.customer-1.com  /www/customers/1<br />
  404. www.customer-2.com  /www/customers/2<br />
  405. # ...<br />
  406. www.customer-N.com  /www/customers/N<br />
  407. </code></p></div>
  408.  
  409.     <p>The <code>http.conf</code> contains this:</p>
  410.  
  411. <div class="example"><p><code>
  412. RewriteEngine on<br />
  413. <br />
  414. RewriteMap   lowercase  int:tolower<br />
  415. <br />
  416. # define the map file<br />
  417. RewriteMap   vhost      txt:/www/conf/vhost.map<br />
  418. <br />
  419. # deal with aliases as above<br />
  420. RewriteCond  %{REQUEST_URI}               !^/icons/<br />
  421. RewriteCond  %{REQUEST_URI}               !^/cgi-bin/<br />
  422. RewriteCond  ${lowercase:%{SERVER_NAME}}  ^(.+)$<br />
  423. # this does the file-based remap<br />
  424. RewriteCond  ${vhost:%1}                  ^(/.*)$<br />
  425. RewriteRule  ^/(.*)$                      %1/docs/$1<br />
  426. <br />
  427. RewriteCond  %{REQUEST_URI}               ^/cgi-bin/<br />
  428. RewriteCond  ${lowercase:%{SERVER_NAME}}  ^(.+)$<br />
  429. RewriteCond  ${vhost:%1}                  ^(/.*)$<br />
  430. RewriteRule  ^/(.*)$                      %1/cgi-bin/$1
  431. </code></p></div>
  432.  
  433. </div></div>
  434. <div id="footer">
  435. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  436. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  437. </body></html>