granicus.if.org Git - apache/blob - docs/manual/rewrite/vhosts.html.en

   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>Dynamic mass virtual hosts with mod_rewrite - 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.3</p>
  16 <img alt="" src="../images/feather.gif" /></div>
  17 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  18 <div id="path">
  19 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Rewrite</a></div><div id="page-content"><div id="preamble"><h1>Dynamic mass virtual hosts with mod_rewrite</h1>
  20 <div class="toplang">
  21 <p><span>Available Languages: </span><a href="../en/rewrite/vhosts.html" title="English">&nbsp;en&nbsp;</a></p>
  22 </div>
  23
  24
  25 <p>This document supplements the <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
  26 <a href="../mod/mod_rewrite.html">reference documentation</a>. It describes
  27 how you can use <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> to create dynamically
  28 configured virtual hosts.</p>
  29
  30 <div class="warning">mod_rewrite is not the best way to configure
  31 virtual hosts. You should first consider the <a href="../vhosts/mass.html">alternatives</a> before resorting to
  32 mod_rewrite.</div>
  33
  34 </div>
  35 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#per-hostname">Virtual Hosts For Arbitrary Hostnames</a></li>
  36 <li><img alt="" src="../images/down.gif" /> <a href="#simple.rewrite">Dynamic
  37     Virtual Hosts Using <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code></a></li>
  38 <li><img alt="" src="../images/down.gif" /> <a href="#xtra-conf">Using a Separate Virtual Host Configuration File</a></li>
  39 </ul><h3>See also</h3><ul class="seealso"><li><a href="../mod/mod_rewrite.html">Module documentation</a></li><li><a href="intro.html">mod_rewrite introduction</a></li><li><a href="remapping.html">Redirection and remapping</a></li><li><a href="access.html">Controlling access</a></li><li><a href="proxy.html">Proxying</a></li><li><a href="rewritemap.html">RewriteMap</a></li><li><a href="advanced.html">Advanced techniques and tricks</a></li><li><a href="avoid.html">When not to use mod_rewrite</a></li></ul></div>
  40 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  41 <div class="section">
  42 <h2><a name="per-hostname" id="per-hostname">Virtual Hosts For Arbitrary Hostnames</a></h2>
  43
  44
  45
  46   <dl>
  47     <dt>Description:</dt>
  48
  49     <dd>
  50     <p>We want to automatically create a virtual host for every hostname
  51     which resolves in our domain, without having to create
  52     new VirtualHost sections.</p>
  53
  54     <p>In this recipe, we assume that we'll be using the hostname
  55     <code>www.<strong>SITE</strong>.example.com</code> for each
  56     user, and serve their content out of
  57     <code>/home/<strong>SITE</strong>/www</code>.</p>
  58     </dd>
  59
  60     <dt>Solution:</dt>
  61
  62     <dd>
  63
  64 <div class="example"><pre>
  65 RewriteEngine on
  66
  67 RewriteMap    lowercase int:tolower
  68
  69 RewriteCond   %{lowercase:%{<strong>HTTP_HOST</strong>}}   ^www\.<strong>([^.]+)</strong>\.example\.com$
  70 RewriteRule   ^(.*) /home/<strong>%1</strong>/www$1
  71 </pre></div></dd>
  72
  73 <dt>Discussion</dt>
  74     <dd>
  75
  76     <div class="warning">You will need to take care of the DNS
  77     resolution - Apache does
  78     not handle name resolution. You'll need either to create CNAME
  79     records for each hostname, or a DNS wildcard record. Creating DNS
  80     records is beyond the scope of this document.</div>
  81
  82 <p>The internal <code>tolower</code> RewriteMap directive is used to
  83 ensure that the hostnames being used are all lowercase, so that there is
  84 no ambiguity in the directory structure which must be created.</p>
  85
  86 <p>Parentheses used in a <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> are captured into the
  87 backreferences <code>%1</code>, <code>%2</code>, etc, while parentheses
  88 used in <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> are
  89 captured into the backreferences <code>$1</code>, <code>$2</code>,
  90 etc.</p>
  91
  92 <p>
  93 As with many techniques discussed in this document, mod_rewrite really
  94 isn't the best way to accomplish this task. You should, instead,
  95 consider using <code class="module"><a href="../mod/mod_vhost_alias.html">mod_vhost_alias</a></code> instead, as it will much
  96 more gracefully handle anything beyond serving static files, such as any
  97 dynamic content, and Alias resolution.
  98 </p>
  99     </dd>
 100   </dl>
 101
 102 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 103 <div class="section">
 104 <h2><a name="simple.rewrite" id="simple.rewrite">Dynamic
 105     Virtual Hosts Using <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code></a></h2>
 106
 107     <p>This extract from <code>httpd.conf</code> does the same
 108     thing as <a href="#simple">the first example</a>. The first
 109     half is very similar to the corresponding part above, except for
 110     some changes, required for backward compatibility and to make the
 111     <code>mod_rewrite</code> part work properly; the second half
 112     configures <code>mod_rewrite</code> to do the actual work.</p>
 113
 114     <p>Because <code>mod_rewrite</code> runs before other URI translation
 115     modules (e.g., <code>mod_alias</code>), <code>mod_rewrite</code> must
 116     be told to explicitly ignore any URLs that would have been handled
 117     by those modules. And, because these rules would otherwise bypass
 118     any <code>ScriptAlias</code> directives, we must have
 119     <code>mod_rewrite</code> explicitly enact those mappings.</p>
 120
 121 <div class="example"><p><code>
 122 # get the server name from the Host: header<br />
 123 UseCanonicalName Off<br />
 124 <br />
 125 # splittable logs<br />
 126 LogFormat "%{Host}i %h %l %u %t \"%r\" %s %b" vcommon<br />
 127 CustomLog logs/access_log vcommon<br />
 128 <br />
 129 &lt;Directory /www/hosts&gt;<br />
 130 <span class="indent">
 131     # ExecCGI is needed here because we can't force<br />
 132     # CGI execution in the way that ScriptAlias does<br />
 133     Options FollowSymLinks ExecCGI<br />
 134 </span>
 135 &lt;/Directory&gt;<br />
 136 <br />
 137 RewriteEngine On<br />
 138 <br />
 139 # a ServerName derived from a Host: header may be any case at all<br />
 140 RewriteMap  lowercase  int:tolower<br />
 141 <br />
 142 ## deal with normal documents first:<br />
 143 # allow Alias /icons/ to work - repeat for other aliases<br />
 144 RewriteCond  %{REQUEST_URI}  !^/icons/<br />
 145 # allow CGIs to work<br />
 146 RewriteCond  %{REQUEST_URI}  !^/cgi-bin/<br />
 147 # do the magic<br />
 148 RewriteRule  ^/(.*)$  /www/hosts/${lowercase:%{SERVER_NAME}}/docs/$1<br />
 149 <br />
 150 ## and now deal with CGIs - we have to force a handler<br />
 151 RewriteCond  %{REQUEST_URI}  ^/cgi-bin/<br />
 152 RewriteRule  ^/(.*)$  /www/hosts/${lowercase:%{SERVER_NAME}}/cgi-bin/$1  [H=cgi-script]<br />
 153 </code></p></div>
 154
 155 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 156 <div class="section">
 157 <h2><a name="xtra-conf" id="xtra-conf">Using a Separate Virtual Host Configuration File</a></h2>
 158
 159     <p>This arrangement uses more advanced <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
 160     features to work out the translation from virtual host to document
 161     root, from a separate configuration file. This provides more
 162     flexibility, but requires more complicated configuration.</p>
 163
 164     <p>The <code>vhost.map</code> file should look something like
 165     this:</p>
 166
 167 <div class="example"><p><code>
 168 www.customer-1.com  /www/customers/1<br />
 169 www.customer-2.com  /www/customers/2<br />
 170 # ...<br />
 171 www.customer-N.com  /www/customers/N<br />
 172 </code></p></div>
 173
 174     <p>The <code>httpd.conf</code> should contain the following:</p>
 175
 176 <div class="example"><p><code>
 177 RewriteEngine on<br />
 178 <br />
 179 RewriteMap   lowercase  int:tolower<br />
 180 <br />
 181 # define the map file<br />
 182 RewriteMap   vhost      txt:/www/conf/vhost.map<br />
 183 <br />
 184 # deal with aliases as above<br />
 185 RewriteCond  %{REQUEST_URI}               !^/icons/<br />
 186 RewriteCond  %{REQUEST_URI}               !^/cgi-bin/<br />
 187 RewriteCond  ${lowercase:%{SERVER_NAME}}  ^(.+)$<br />
 188 # this does the file-based remap<br />
 189 RewriteCond  ${vhost:%1}                  ^(/.*)$<br />
 190 RewriteRule  ^/(.*)$                      %1/docs/$1<br />
 191 <br />
 192 RewriteCond  %{REQUEST_URI}               ^/cgi-bin/<br />
 193 RewriteCond  ${lowercase:%{SERVER_NAME}}  ^(.+)$<br />
 194 RewriteCond  ${vhost:%1}                  ^(/.*)$<br />
 195 RewriteRule  ^/(.*)$                      %1/cgi-bin/$1 [H=cgi-script]
 196 </code></p></div>
 197
 198 </div></div>
 199 <div class="bottomlang">
 200 <p><span>Available Languages: </span><a href="../en/rewrite/vhosts.html" title="English">&nbsp;en&nbsp;</a></p>
 201 </div><div id="footer">
 202 <p class="apache">Copyright 2010 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 203 <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>
 204 </body></html>