Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_index_module.xml @ 2691:5f961aa083db
Mentioned realip module in the listen directive for mail.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 23 Mar 2021 20:41:45 +0000 |
parents | 95c3c3bbf1ce |
children |
rev | line source |
---|---|
222
bfe3eff81d04
Removed redundant encoding specification.
Ruslan Ermilov <ru@nginx.com>
parents:
153
diff
changeset
|
1 <?xml version="1.0"?> |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
580
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
351
diff
changeset
|
3 <!-- |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
351
diff
changeset
|
4 Copyright (C) Igor Sysoev |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
351
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
351
diff
changeset
|
6 --> |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
351
diff
changeset
|
7 |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_http_index_module" |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_index_module.html" |
589 | 12 lang="en" |
724
0422511d9bee
Improved descriptions of indexing modules and mentioned others in index module.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
13 rev="2"> |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 <para> |
966 | 18 The <literal>ngx_http_index_module</literal> module processes requests |
271 | 19 ending with the slash character (‘<literal>/</literal>’). |
966 | 20 Such requests can also be processed by the |
724
0422511d9bee
Improved descriptions of indexing modules and mentioned others in index module.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
21 <link doc="ngx_http_autoindex_module.xml">ngx_http_autoindex_module</link> |
0422511d9bee
Improved descriptions of indexing modules and mentioned others in index module.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
22 and |
0422511d9bee
Improved descriptions of indexing modules and mentioned others in index module.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
23 <link doc="ngx_http_random_index_module.xml">ngx_http_random_index_module</link> |
0422511d9bee
Improved descriptions of indexing modules and mentioned others in index module.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
24 modules. |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 </para> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 </section> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 |
320 | 30 <section id="example" name="Example Configuration"> |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 <para> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
34 location / { |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
35 index index.$geo.html index.html; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
36 } |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 </example> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 </para> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 </section> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 |
320 | 43 <section id="directives" name="Directives"> |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 <directive name="index"> |
271 | 46 <syntax><value>file</value> ...</syntax> |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 <default>index.html</default> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 <context>http</context> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 <context>server</context> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
50 <context>location</context> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
51 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 <para> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
53 Defines files that will be used as an index. |
271 | 54 The <value>file</value> name can contain variables. |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
55 Files are checked in the specified order. |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
56 The last element of the list can be a file with an absolute path. |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 Example: |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
58 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
59 index index.$geo.html index.0.html /index.html; |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
60 </example> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
61 </para> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
62 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
63 <para> |
966 | 64 It should be noted that using an index file causes an internal redirect, |
65 and the request can be processed in a different location. | |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
66 For example, with the following configuration: |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
67 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
68 location = / { |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
69 index index.html; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
70 } |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
72 location / { |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
73 ... |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
320
diff
changeset
|
74 } |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 </example> |
966 | 76 a “<literal>/</literal>” request will actually be processed in the |
271 | 77 second location as “<literal>/index.html</literal>”. |
153
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 </para> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 </directive> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 </section> |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
83 |
317ac898ba50
Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 </module> |