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 Version 2.5</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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body id="manual-page"><div id="page-header">
  17 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  18 <p class="apache">Apache HTTP Server Version 2.5</p>
  19 <img alt="" src="../images/feather.gif" /></div>
  20 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  21 <div id="path">
  22 <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.5</a> &gt; <a href="./">Rewrite</a></div><div id="page-content"><div id="preamble"><h1>Dynamic mass virtual hosts with mod_rewrite</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/rewrite/vhosts.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26
  27
  28 <p>This document supplements the <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
  29 <a href="../mod/mod_rewrite.html">reference documentation</a>. It describes
  30 how you can use <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> to create dynamically
  31 configured virtual hosts.</p>
  32
  33 <div class="warning">mod_rewrite is not the best way to configure
  34 virtual hosts. You should first consider the <a href="../vhosts/mass.html">alternatives</a> before resorting to
  35 mod_rewrite. See also the "<a href="avoid.html#vhosts">how to avoid
  36 mod_rewrite</a> document.</div>
  37
  38 </div>
  39 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#per-hostname">Virtual Hosts For Arbitrary Hostnames</a></li>
  40 <li><img alt="" src="../images/down.gif" /> <a href="#simple.rewrite">Dynamic
  41     Virtual Hosts Using <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code></a></li>
  42 <li><img alt="" src="../images/down.gif" /> <a href="#xtra-conf">Using a Separate Virtual Host Configuration File</a></li>
  43 </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</a></li><li><a href="avoid.html">When not to use mod_rewrite</a></li></ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  44 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  45 <div class="section">
  46 <h2><a name="per-hostname" id="per-hostname">Virtual Hosts For Arbitrary Hostnames</a></h2>
  47
  48
  49
  50   <dl>
  51     <dt>Description:</dt>
  52
  53     <dd>
  54     <p>We want to automatically create a virtual host for every hostname
  55     which resolves in our domain, without having to create
  56     new VirtualHost sections.</p>
  57
  58     <p>In this recipe, we assume that we'll be using the hostname
  59     <code>www.<strong>SITE</strong>.example.com</code> for each
  60     user, and serve their content out of
  61     <code>/home/<strong>SITE</strong>/www</code>.</p>
  62     </dd>
  63
  64     <dt>Solution:</dt>
  65
  66     <dd>
  67
  68 <pre class="prettyprint lang-config">RewriteEngine on
  69
  70 RewriteMap    lowercase int:tolower
  71
  72 RewriteCond   ${lowercase:%{<strong>HTTP_HOST</strong>}}   ^www\.<strong>([^.]+)</strong>\.example\.com$
  73 RewriteRule   ^(.*) /home/<strong>%1</strong>/www$1</pre>
  74 </dd>
  75
  76 <dt>Discussion</dt>
  77     <dd>
  78
  79     <div class="warning">You will need to take care of the DNS
  80     resolution - Apache does
  81     not handle name resolution. You'll need either to create CNAME
  82     records for each hostname, or a DNS wildcard record. Creating DNS
  83     records is beyond the scope of this document.</div>
  84
  85 <p>The internal <code>tolower</code> RewriteMap directive is used to
  86 ensure that the hostnames being used are all lowercase, so that there is
  87 no ambiguity in the directory structure which must be created.</p>
  88
  89 <p>Parentheses used in a <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> are captured into the
  90 backreferences <code>%1</code>, <code>%2</code>, etc, while parentheses
  91 used in <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> are
  92 captured into the backreferences <code>$1</code>, <code>$2</code>,
  93 etc.</p>
  94
  95 <p>
  96 As with many techniques discussed in this document, mod_rewrite really
  97 isn't the best way to accomplish this task. You should, instead,
  98 consider using <code class="module"><a href="../mod/mod_vhost_alias.html">mod_vhost_alias</a></code> instead, as it will much
  99 more gracefully handle anything beyond serving static files, such as any
 100 dynamic content, and Alias resolution.
 101 </p>
 102     </dd>
 103   </dl>
 104
 105 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 106 <div class="section">
 107 <h2><a name="simple.rewrite" id="simple.rewrite">Dynamic
 108     Virtual Hosts Using <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code></a></h2>
 109
 110     <p>This extract from <code>httpd.conf</code> does the same
 111     thing as <a href="#per-hostname">the first example</a>. The first
 112     half is very similar to the corresponding part above, except for
 113     some changes, required for backward compatibility and to make the
 114     <code>mod_rewrite</code> part work properly; the second half
 115     configures <code>mod_rewrite</code> to do the actual work.</p>
 116
 117     <p>Because <code>mod_rewrite</code> runs before other URI translation
 118     modules (e.g., <code>mod_alias</code>), <code>mod_rewrite</code> must
 119     be told to explicitly ignore any URLs that would have been handled
 120     by those modules. And, because these rules would otherwise bypass
 121     any <code>ScriptAlias</code> directives, we must have
 122     <code>mod_rewrite</code> explicitly enact those mappings.</p>
 123
 124 <pre class="prettyprint lang-config"># get the server name from the Host: header
 125 UseCanonicalName Off
 126
 127 # splittable logs
 128 LogFormat "%{Host}i %h %l %u %t \"%r\" %s %b" vcommon
 129 CustomLog logs/access_log vcommon
 130
 131 &lt;Directory /www/hosts&gt;
 132     # ExecCGI is needed here because we can't force
 133     # CGI execution in the way that ScriptAlias does
 134     Options FollowSymLinks ExecCGI
 135 &lt;/Directory&gt;
 136
 137 RewriteEngine On
 138
 139 # a ServerName derived from a Host: header may be any case at all
 140 RewriteMap  lowercase  int:tolower
 141
 142 ## deal with normal documents first:
 143 # allow Alias /icons/ to work - repeat for other aliases
 144 RewriteCond  %{REQUEST_URI}  !^/icons/
 145 # allow CGIs to work
 146 RewriteCond  %{REQUEST_URI}  !^/cgi-bin/
 147 # do the magic
 148 RewriteRule  ^/(.*)$  /www/hosts/${lowercase:%{SERVER_NAME}}/docs/$1
 149
 150 ## and now deal with CGIs - we have to force a handler
 151 RewriteCond  %{REQUEST_URI}  ^/cgi-bin/
 152 RewriteRule  ^/(.*)$  /www/hosts/${lowercase:%{SERVER_NAME}}/cgi-bin/$1  [H=cgi-script]</pre>
 153
 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 customer-1.example.com  /www/customers/1<br />
 169 customer-2.example.com  /www/customers/2<br />
 170 # ...<br />
 171 customer-N.example.com  /www/customers/N<br />
 172 </code></p></div>
 173
 174     <p>The <code>httpd.conf</code> should contain the following:</p>
 175
 176 <pre class="prettyprint lang-config">RewriteEngine on
 177
 178 RewriteMap   lowercase  int:tolower
 179
 180 # define the map file
 181 RewriteMap   vhost      txt:/www/conf/vhost.map
 182
 183 # deal with aliases as above
 184 RewriteCond  %{REQUEST_URI}               !^/icons/
 185 RewriteCond  %{REQUEST_URI}               !^/cgi-bin/
 186 RewriteCond  ${lowercase:%{SERVER_NAME}}  ^(.+)$
 187 # this does the file-based remap
 188 RewriteCond  ${vhost:%1}                  ^(/.*)$
 189 RewriteRule  ^/(.*)$                      %1/docs/$1
 190
 191 RewriteCond  %{REQUEST_URI}               ^/cgi-bin/
 192 RewriteCond  ${lowercase:%{SERVER_NAME}}  ^(.+)$
 193 RewriteCond  ${vhost:%1}                  ^(/.*)$
 194 RewriteRule  ^/(.*)$                      %1/cgi-bin/$1 [H=cgi-script]</pre>
 195
 196
 197 </div></div>
 198 <div class="bottomlang">
 199 <p><span>Available Languages: </span><a href="../en/rewrite/vhosts.html" title="English">&nbsp;en&nbsp;</a></p>
 200 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 201 <script type="text/javascript"><!--//--><![CDATA[//><!--
 202 var comments_shortname = 'httpd';
 203 var comments_identifier = 'http://httpd.apache.org/docs/trunk/rewrite/vhosts.html';
 204 (function(w, d) {
 205     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 206         d.write('<div id="comments_thread"><\/div>');
 207         var s = d.createElement('script');
 208         s.type = 'text/javascript';
 209         s.async = true;
 210         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 211         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 212     }
 213     else {
 214         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 215     }
 216 })(window, document);
 217 //--><!]]></script></div><div id="footer">
 218 <p class="apache">Copyright 2015 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>
 219 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 220 if (typeof(prettyPrint) !== 'undefined') {
 221     prettyPrint();
 222 }
 223 //--><!]]></script>
 224 </body></html>