| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> |
| <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" /> |
| <!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>Dynamic mass virtual hosts with mod_rewrite - Apache HTTP Server Version 2.4</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <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" /> |
| <script src="../style/scripts/prettify.min.js" type="text/javascript"> |
| </script> |
| |
| <link href="../images/favicon.ico" rel="shortcut icon" /></head> |
| <body id="manual-page"><div id="page-header"> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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> |
| <p class="apache">Apache HTTP Server Version 2.4</p> |
| <img alt="" src="../images/feather.png" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.4</a> > <a href="./">Rewrite</a></div><div id="page-content"><div id="preamble"><h1>Dynamic mass virtual hosts with mod_rewrite</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/rewrite/vhosts.html" title="English"> en </a> | |
| <a href="../fr/rewrite/vhosts.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> |
| </div> |
| |
| |
| <p>This document supplements the <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> |
| <a href="../mod/mod_rewrite.html">reference documentation</a>. It describes |
| how you can use <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> to create dynamically |
| configured virtual hosts.</p> |
| |
| <div class="warning">mod_rewrite is not the best way to configure |
| virtual hosts. You should first consider the <a href="../vhosts/mass.html">alternatives</a> before resorting to |
| mod_rewrite. See also the "<a href="avoid.html#vhosts">how to avoid |
| mod_rewrite</a> document.</div> |
| |
| </div> |
| <div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#per-hostname">Virtual Hosts For Arbitrary Hostnames</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#simple.rewrite">Dynamic |
| Virtual Hosts Using <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code></a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#xtra-conf">Using a Separate Virtual Host Configuration File</a></li> |
| </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><li><a href="#comments_section">Comments</a></li></ul></div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="per-hostname" id="per-hostname">Virtual Hosts For Arbitrary Hostnames</a></h2> |
| |
| |
| |
| <dl> |
| <dt>Description:</dt> |
| |
| <dd> |
| <p>We want to automatically create a virtual host for every hostname |
| which resolves in our domain, without having to create |
| new VirtualHost sections.</p> |
| |
| <p>In this recipe, we assume that we'll be using the hostname |
| <code>www.<strong>SITE</strong>.example.com</code> for each |
| user, and serve their content out of |
| <code>/home/<strong>SITE</strong>/www</code>.</p> |
| </dd> |
| |
| <dt>Solution:</dt> |
| |
| <dd> |
| |
| <pre class="prettyprint lang-config">RewriteEngine on |
| |
| RewriteMap lowercase int:tolower |
| |
| RewriteCond "${lowercase:%{<strong>HTTP_HOST</strong>}}" "^www\.<strong>([^.]+)</strong>\.example\.com$" |
| RewriteRule "^(.*)" "/home/<strong>%1</strong>/www$1"</pre> |
| </dd> |
| |
| <dt>Discussion</dt> |
| <dd> |
| |
| <div class="warning">You will need to take care of the DNS |
| resolution - Apache does |
| not handle name resolution. You'll need either to create CNAME |
| records for each hostname, or a DNS wildcard record. Creating DNS |
| records is beyond the scope of this document.</div> |
| |
| <p>The internal <code>tolower</code> RewriteMap directive is used to |
| ensure that the hostnames being used are all lowercase, so that there is |
| no ambiguity in the directory structure which must be created.</p> |
| |
| <p>Parentheses used in a <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> are captured into the |
| backreferences <code>%1</code>, <code>%2</code>, etc, while parentheses |
| used in <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> are |
| captured into the backreferences <code>$1</code>, <code>$2</code>, |
| etc.</p> |
| |
| <p> |
| As with many techniques discussed in this document, mod_rewrite really |
| isn't the best way to accomplish this task. You should, instead, |
| consider using <code class="module"><a href="../mod/mod_vhost_alias.html">mod_vhost_alias</a></code> instead, as it will much |
| more gracefully handle anything beyond serving static files, such as any |
| dynamic content, and Alias resolution. |
| </p> |
| </dd> |
| </dl> |
| |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="simple.rewrite" id="simple.rewrite">Dynamic |
| Virtual Hosts Using <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code></a></h2> |
| |
| <p>This extract from <code>httpd.conf</code> does the same |
| thing as <a href="#per-hostname">the first example</a>. The first |
| half is very similar to the corresponding part above, except for |
| some changes, required for backward compatibility and to make the |
| <code>mod_rewrite</code> part work properly; the second half |
| configures <code>mod_rewrite</code> to do the actual work.</p> |
| |
| <p>Because <code>mod_rewrite</code> runs before other URI translation |
| modules (e.g., <code>mod_alias</code>), <code>mod_rewrite</code> must |
| be told to explicitly ignore any URLs that would have been handled |
| by those modules. And, because these rules would otherwise bypass |
| any <code>ScriptAlias</code> directives, we must have |
| <code>mod_rewrite</code> explicitly enact those mappings.</p> |
| |
| <pre class="prettyprint lang-config"># get the server name from the Host: header |
| UseCanonicalName Off |
| |
| # splittable logs |
| LogFormat "%{Host}i %h %l %u %t \"%r\" %s %b" vcommon |
| CustomLog "logs/access_log" vcommon |
| |
| <Directory "/www/hosts"> |
| # ExecCGI is needed here because we can't force |
| # CGI execution in the way that ScriptAlias does |
| Options FollowSymLinks ExecCGI |
| </Directory> |
| |
| RewriteEngine On |
| |
| # a ServerName derived from a Host: header may be any case at all |
| RewriteMap lowercase int:tolower |
| |
| ## deal with normal documents first: |
| # allow Alias "/icons/" to work - repeat for other aliases |
| RewriteCond "%{REQUEST_URI}" "!^/icons/" |
| # allow CGIs to work |
| RewriteCond "%{REQUEST_URI}" "!^/cgi-bin/" |
| # do the magic |
| RewriteRule "^/(.*)$" "/www/hosts/${lowercase:%{SERVER_NAME}}/docs/$1" |
| |
| ## and now deal with CGIs - we have to force a handler |
| RewriteCond "%{REQUEST_URI}" "^/cgi-bin/" |
| RewriteRule "^/(.*)$" "/www/hosts/${lowercase:%{SERVER_NAME}}/cgi-bin/$1" [H=cgi-script]</pre> |
| |
| |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="xtra-conf" id="xtra-conf">Using a Separate Virtual Host Configuration File</a></h2> |
| |
| <p>This arrangement uses more advanced <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> |
| features to work out the translation from virtual host to document |
| root, from a separate configuration file. This provides more |
| flexibility, but requires more complicated configuration.</p> |
| |
| <p>The <code>vhost.map</code> file should look something like |
| this:</p> |
| |
| <div class="example"><p><code> |
| customer-1.example.com /www/customers/1<br /> |
| customer-2.example.com /www/customers/2<br /> |
| # ...<br /> |
| customer-N.example.com /www/customers/N<br /> |
| </code></p></div> |
| |
| <p>The <code>httpd.conf</code> should contain the following:</p> |
| |
| <pre class="prettyprint lang-config">RewriteEngine on |
| |
| RewriteMap lowercase int:tolower |
| |
| # define the map file |
| RewriteMap vhost "txt:/www/conf/vhost.map" |
| |
| # deal with aliases as above |
| RewriteCond "%{REQUEST_URI}" "!^/icons/" |
| RewriteCond "%{REQUEST_URI}" "!^/cgi-bin/" |
| RewriteCond "${lowercase:%{SERVER_NAME}}" "^(.+)$" |
| # this does the file-based remap |
| RewriteCond "${vhost:%1}" "^(/.*)$" |
| RewriteRule "^/(.*)$" "%1/docs/$1" |
| |
| RewriteCond "%{REQUEST_URI}" "^/cgi-bin/" |
| RewriteCond "${lowercase:%{SERVER_NAME}}" "^(.+)$" |
| RewriteCond "${vhost:%1}" "^(/.*)$" |
| RewriteRule "^/cgi-bin/(.*)$" "%1/cgi-bin/$1" [H=cgi-script]</pre> |
| |
| |
| </div></div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/rewrite/vhosts.html" title="English"> en </a> | |
| <a href="../fr/rewrite/vhosts.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> |
| </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&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed 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="https://httpd.apache.org/lists.html">mailing lists</a>.</div> |
| <script type="text/javascript"><!--//--><![CDATA[//><!-- |
| var comments_shortname = 'httpd'; |
| var comments_identifier = 'http://httpd.apache.org/docs/2.4/rewrite/vhosts.html'; |
| (function(w, d) { |
| if (w.location.hostname.toLowerCase() == "httpd.apache.org") { |
| d.write('<div id="comments_thread"><\/div>'); |
| var s = d.createElement('script'); |
| s.type = 'text/javascript'; |
| s.async = true; |
| s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; |
| (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); |
| } |
| else { |
| d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); |
| } |
| })(window, document); |
| //--><!]]></script></div><div id="footer"> |
| <p class="apache">Copyright 2021 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> |
| <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!-- |
| if (typeof(prettyPrint) !== 'undefined') { |
| prettyPrint(); |
| } |
| //--><!]]></script> |
| </body></html> |