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
8
<title>Mapping URLs to Filesystem Locations - 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.2</p>
16
<img alt="" src="./images/feather.gif" /></div>
17
<div class="up"><a href="./"><img title="<-" alt="<-" src="./images/left.gif" /></a></div>
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/">Documentation</a> > <a href="./">Version 2.2</a></div><div id="page-content"><div id="preamble"><h1>Mapping URLs to Filesystem Locations</h1>
21
<p><span>Available Languages: </span><a href="./en/urlmapping.html" title="English"> en </a> |
22
<a href="./ja/urlmapping.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
23
<a href="./ko/urlmapping.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
26
<p>This document explains how Apache uses the URL of a request
27
to determine the filesystem location from which to serve a
30
<div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#related">Related Modules and Directives</a></li>
31
<li><img alt="" src="./images/down.gif" /> <a href="#documentroot">DocumentRoot</a></li>
32
<li><img alt="" src="./images/down.gif" /> <a href="#outside">Files Outside the DocumentRoot</a></li>
33
<li><img alt="" src="./images/down.gif" /> <a href="#user">User Directories</a></li>
34
<li><img alt="" src="./images/down.gif" /> <a href="#redirect">URL Redirection</a></li>
35
<li><img alt="" src="./images/down.gif" /> <a href="#proxy">Reverse Proxy</a></li>
36
<li><img alt="" src="./images/down.gif" /> <a href="#rewrite">Rewriting Engine</a></li>
37
<li><img alt="" src="./images/down.gif" /> <a href="#notfound">File Not Found</a></li>
39
<div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
41
<h2><a name="related" id="related">Related Modules and Directives</a></h2>
43
<table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="./mod/mod_alias.html">mod_alias</a></code></li><li><code class="module"><a href="./mod/mod_proxy.html">mod_proxy</a></code></li><li><code class="module"><a href="./mod/mod_rewrite.html">mod_rewrite</a></code></li><li><code class="module"><a href="./mod/mod_userdir.html">mod_userdir</a></code></li><li><code class="module"><a href="./mod/mod_speling.html">mod_speling</a></code></li><li><code class="module"><a href="./mod/mod_vhost_alias.html">mod_vhost_alias</a></code></li></ul></td><td><ul><li><code class="directive"><a href="./mod/mod_alias.html#alias">Alias</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#aliasmatch">AliasMatch</a></code></li><li><code class="directive"><a href="./mod/mod_speling.html#checkspelling">CheckSpelling</a></code></li><li><code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code></li><li><code class="directive"><a href="./mod/core.html#errordocument">ErrorDocument</a></code></li><li><code class="directive"><a href="./mod/core.html#options">Options</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypass">ProxyPass</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypassreverse">ProxyPassReverse</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypassreversecookiedomain">ProxyPassReverseCookieDomain</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypassreversecookiepath">ProxyPassReverseCookiePath</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#redirect">Redirect</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#redirectmatch">RedirectMatch</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewritecond">RewriteCond</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewritematch">RewriteMatch</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#scriptaliasmatch">ScriptAliasMatch</a></code></li><li><code class="directive"><a href="./mod/mod_userdir.html#userdir">UserDir</a></code></li></ul></td></tr></table>
44
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
46
<h2><a name="documentroot" id="documentroot">DocumentRoot</a></h2>
48
<p>In deciding what file to serve for a given request, Apache's
49
default behavior is to take the URL-Path for the request (the part
50
of the URL following the hostname and port) and add it to the end
51
of the <code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code> specified
52
in your configuration files. Therefore, the files and directories
53
underneath the <code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code>
54
make up the basic document tree which will be visible from the
57
<p>Apache is also capable of <a href="vhosts/">Virtual
58
Hosting</a>, where the server receives requests for more than one
59
host. In this case, a different <code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code> can be specified for each
60
virtual host, or alternatively, the directives provided by the
61
module <code class="module"><a href="./mod/mod_vhost_alias.html">mod_vhost_alias</a></code> can
62
be used to dynamically determine the appropriate place from which
63
to serve content based on the requested IP address or
65
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
67
<h2><a name="outside" id="outside">Files Outside the DocumentRoot</a></h2>
69
<p>There are frequently circumstances where it is necessary to
70
allow web access to parts of the filesystem that are not strictly
71
underneath the <code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code>. Apache offers several
72
different ways to accomplish this. On Unix systems, symbolic links
73
can bring other parts of the filesystem under the <code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code>. For security reasons,
74
Apache will follow symbolic links only if the <code class="directive"><a href="./mod/core.html#options">Options</a></code> setting for the relevant
75
directory includes <code>FollowSymLinks</code> or
76
<code>SymLinksIfOwnerMatch</code>.</p>
78
<p>Alternatively, the <code class="directive"><a href="./mod/mod_alias.html#alias">Alias</a></code> directive will map any part
79
of the filesystem into the web space. For example, with</p>
81
<div class="example"><p><code>Alias /docs /var/web</code></p></div>
83
<p>the URL <code>http://www.example.com/docs/dir/file.html</code>
84
will be served from <code>/var/web/dir/file.html</code>. The
85
<code class="directive"><a href="./mod/mod_alias.html#scriptalias">ScriptAlias</a></code> directive
86
works the same way, with the additional effect that all content
87
located at the target path is treated as <a class="glossarylink" href="./glossary.html#cgi" title="see glossary">CGI</a> scripts.</p>
89
<p>For situations where you require additional flexibility, you
90
can use the <code class="directive"><a href="./mod/mod_alias.html#aliasmatch">AliasMatch</a></code>
91
and <code class="directive"><a href="./mod/mod_alias.html#scriptaliasmatch">ScriptAliasMatch</a></code>
92
directives to do powerful <a class="glossarylink" href="./glossary.html#regex" title="see glossary">regular
93
expression</a> based matching and substitution. For
96
<div class="example"><p><code>ScriptAliasMatch ^/~([a-zA-Z0-9]+)/cgi-bin/(.+)
97
/home/$1/cgi-bin/$2</code></p></div>
99
<p>will map a request to
100
<code>http://example.com/~user/cgi-bin/script.cgi</code> to the
101
path <code>/home/user/cgi-bin/script.cgi</code> and will treat
102
the resulting file as a CGI script.</p>
103
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
104
<div class="section">
105
<h2><a name="user" id="user">User Directories</a></h2>
107
<p>Traditionally on Unix systems, the home directory of a
108
particular <em>user</em> can be referred to as
109
<code>~user/</code>. The module <code class="module"><a href="./mod/mod_userdir.html">mod_userdir</a></code>
110
extends this idea to the web by allowing files under each user's
111
home directory to be accessed using URLs such as the
114
<div class="example"><p><code>http://www.example.com/~user/file.html</code></p></div>
116
<p>For security reasons, it is inappropriate to give direct
117
access to a user's home directory from the web. Therefore, the
118
<code class="directive"><a href="./mod/mod_userdir.html#userdir">UserDir</a></code> directive
119
specifies a directory underneath the user's home directory
120
where web files are located. Using the default setting of
121
<code>Userdir public_html</code>, the above URL maps to a file
123
<code>/home/user/public_html/file.html</code> where
124
<code>/home/user/</code> is the user's home directory as
125
specified in <code>/etc/passwd</code>.</p>
127
<p>There are also several other forms of the
128
<code>Userdir</code> directive which you can use on systems
129
where <code>/etc/passwd</code> does not contain the location of
130
the home directory.</p>
132
<p>Some people find the "~" symbol (which is often encoded on the
133
web as <code>%7e</code>) to be awkward and prefer to use an
134
alternate string to represent user directories. This functionality
135
is not supported by mod_userdir. However, if users' home
136
directories are structured in a regular way, then it is possible
137
to use the <code class="directive"><a href="./mod/mod_alias.html#aliasmatch">AliasMatch</a></code>
138
directive to achieve the desired effect. For example, to make
139
<code>http://www.example.com/upages/user/file.html</code> map to
140
<code>/home/user/public_html/file.html</code>, use the following
141
<code>AliasMatch</code> directive:</p>
143
<div class="example"><p><code>AliasMatch ^/upages/([a-zA-Z0-9]+)/?(.*)
144
/home/$1/public_html/$2</code></p></div>
145
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
146
<div class="section">
147
<h2><a name="redirect" id="redirect">URL Redirection</a></h2>
149
<p>The configuration directives discussed in the above sections
150
tell Apache to get content from a specific place in the filesystem
151
and return it to the client. Sometimes, it is desirable instead to
152
inform the client that the requested content is located at a
153
different URL, and instruct the client to make a new request with
154
the new URL. This is called <em>redirection</em> and is
155
implemented by the <code class="directive"><a href="./mod/mod_alias.html#redirect">Redirect</a></code> directive. For example, if
156
the contents of the directory <code>/foo/</code> under the
157
<code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code> are moved
158
to the new directory <code>/bar/</code>, you can instruct clients
159
to request the content at the new location as follows:</p>
161
<div class="example"><p><code>Redirect permanent /foo/
162
http://www.example.com/bar/</code></p></div>
164
<p>This will redirect any URL-Path starting in
165
<code>/foo/</code> to the same URL path on the
166
<code>www.example.com</code> server with <code>/bar/</code>
167
substituted for <code>/foo/</code>. You can redirect clients to
168
any server, not only the origin server.</p>
170
<p>Apache also provides a <code class="directive"><a href="./mod/mod_alias.html#redirectmatch">RedirectMatch</a></code> directive for more
171
complicated rewriting problems. For example, to redirect requests
172
for the site home page to a different site, but leave all other
173
requests alone, use the following configuration:</p>
175
<div class="example"><p><code>RedirectMatch permanent ^/$
176
http://www.example.com/startpage.html</code></p></div>
178
<p>Alternatively, to temporarily redirect all pages on one site
179
to a particular page on another site, use the following:</p>
181
<div class="example"><p><code>RedirectMatch temp .*
182
http://othersite.example.com/startpage.html</code></p></div>
183
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
184
<div class="section">
185
<h2><a name="proxy" id="proxy">Reverse Proxy</a></h2>
187
<p>Apache also allows you to bring remote documents into the URL space
188
of the local server. This technique is called <em>reverse
189
proxying</em> because the web server acts like a proxy server by
190
fetching the documents from a remote server and returning them to the
191
client. It is different from normal proxying because, to the client,
192
it appears the documents originate at the reverse proxy server.</p>
194
<p>In the following example, when clients request documents under the
195
<code>/foo/</code> directory, the server fetches those documents from
196
the <code>/bar/</code> directory on <code>internal.example.com</code>
197
and returns them to the client as if they were from the local
200
<div class="example"><p><code>
201
ProxyPass /foo/ http://internal.example.com/bar/<br />
202
ProxyPassReverse /foo/ http://internal.example.com/bar/
203
ProxyPassReverseCookieDomain internal.example.com public.example.com
204
ProxyPassReverseCookiePath /foo/ /bar/
207
<p>The <code class="directive"><a href="./mod/mod_proxy.html#proxypass">ProxyPass</a></code> configures
208
the server to fetch the appropriate documents, while the
209
<code class="directive"><a href="./mod/mod_proxy.html#proxypassreverse">ProxyPassReverse</a></code>
210
directive rewrites redirects originating at
211
<code>internal.example.com</code> so that they target the appropriate
212
directory on the local server. Similarly, the
213
<code class="directive"><a href="./mod/mod_proxy.html#proxypassreversecookiedomain">ProxyPassReverseCookieDomain</a></code>
214
and <code class="directive"><a href="./mod/mod_proxy.html#proxypassreversecookiedomain">ProxyPassReverseCookieDomain</a></code>
215
rewrite cookies set by the backend server.</p>
216
<p>It is important to note, however, that
217
links inside the documents will not be rewritten. So any absolute
218
links on <code>internal.example.com</code> will result in the client
219
breaking out of the proxy server and requesting directly from
220
<code>internal.example.com</code>. A third-party module
221
<a href="http://apache.webthing.com/mod_proxy_html/">mod_proxy_html</a>
222
is available to rewrite links in HTML and XHTML.</p>
223
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
224
<div class="section">
225
<h2><a name="rewrite" id="rewrite">Rewriting Engine</a></h2>
227
<p>When even more powerful substitution is required, the rewriting
228
engine provided by <code class="module"><a href="./mod/mod_rewrite.html">mod_rewrite</a></code>
229
can be useful. The directives provided by this module use
230
characteristics of the request such as browser type or source IP
231
address in deciding from where to serve content. In addition,
232
mod_rewrite can use external database files or programs to
233
determine how to handle a request. The rewriting engine is capable
234
of performing all three types of mappings discussed above:
235
internal redirects (aliases), external redirects, and proxying.
236
Many practical examples employing mod_rewrite are discussed in the
237
<a href="misc/rewriteguide.html">URL Rewriting Guide</a>.</p>
238
</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
239
<div class="section">
240
<h2><a name="notfound" id="notfound">File Not Found</a></h2>
242
<p>Inevitably, URLs will be requested for which no matching
243
file can be found in the filesystem. This can happen for
244
several reasons. In some cases, it can be a result of moving
245
documents from one location to another. In this case, it is
246
best to use <a href="#redirect">URL redirection</a> to inform
247
clients of the new location of the resource. In this way, you
248
can assure that old bookmarks and links will continue to work,
249
even though the resource is at a new location.</p>
251
<p>Another common cause of "File Not Found" errors is
252
accidental mistyping of URLs, either directly in the browser,
253
or in HTML links. Apache provides the module
254
<code class="module"><a href="./mod/mod_speling.html">mod_speling</a></code> (sic) to help with
255
this problem. When this module is activated, it will intercept
256
"File Not Found" errors and look for a resource with a similar
257
filename. If one such file is found, mod_speling will send an
258
HTTP redirect to the client informing it of the correct
259
location. If several "close" files are found, a list of
260
available alternatives will be presented to the client.</p>
262
<p>An especially useful feature of mod_speling, is that it will
263
compare filenames without respect to case. This can help
264
systems where users are unaware of the case-sensitive nature of
265
URLs and the unix filesystem. But using mod_speling for
266
anything more than the occasional URL correction can place
267
additional load on the server, since each "incorrect" request
268
is followed by a URL redirection and a new request from the
271
<p>If all attempts to locate the content fail, Apache returns
272
an error page with HTTP status code 404 (file not found). The
273
appearance of this page is controlled with the
274
<code class="directive"><a href="./mod/core.html#errordocument">ErrorDocument</a></code> directive
275
and can be customized in a flexible manner as discussed in the
276
<a href="custom-error.html">Custom error responses</a>
279
<div class="bottomlang">
280
<p><span>Available Languages: </span><a href="./en/urlmapping.html" title="English"> en </a> |
281
<a href="./ja/urlmapping.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
282
<a href="./ko/urlmapping.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
283
</div><div id="footer">
284
<p class="apache">Copyright 2006 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>
285
<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>
b'\\ No newline at end of file'
added
removed
docs/manual/urlmapping.html.en
