Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_autoindex_module.xml @ 2769:16f6fa718be2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated TLSv1.3 support notes. Previous notes described some early development snapshot of OpenSSL 1.1.1 with disabled TLSv1.3 by default. It was then enabled in the first alpha. Further, the updated text covers later major releases such as OpenSSL 3.0.
author Sergey Kandaurov <pluknet@nginx.com>
date Thu, 30 Sep 2021 16:29:20 +0300
parents 6866a74393e0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
7
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_autoindex_module"
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_autoindex_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
1540
6866a74393e0 Added a hint about xslt transformation to autoindex_format.
Valentin Bartenev <vbart@nginx.com>
parents: 1374
diff changeset
13 rev="4">
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="summary">
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <para>
724
0422511d9bee Improved descriptions of indexing modules and mentioned others in index module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
18 The <literal>ngx_http_autoindex_module</literal> module processes requests
0422511d9bee Improved descriptions of indexing modules and mentioned others in index module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
19 ending with the slash character (‘<literal>/</literal>’) and produces
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 a directory listing.
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 Usually a request is passed to the <literal>ngx_http_autoindex_module</literal>
364
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
22 module when the
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
23 <link doc="ngx_http_index_module.xml">ngx_http_index_module</link> module
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 724
diff changeset
24 cannot find an index file.
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 </para>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 </section>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 <section id="example" name="Example Configuration">
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 <para>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 <example>
351
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 315
diff changeset
34 location / {
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 315
diff changeset
35 autoindex on;
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 315
diff changeset
36 }
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 </example>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 </para>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 </section>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 <section id="directives" name="Directives">
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 <directive name="autoindex">
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 <syntax><literal>on</literal> | <literal>off</literal></syntax>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 <default>off</default>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 <context>http</context>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <context>server</context>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <context>location</context>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 724
diff changeset
53 Enables or disables the directory listing output.
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 </para>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 </directive>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 <directive name="autoindex_exact_size">
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 <syntax><literal>on</literal> | <literal>off</literal></syntax>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 <default>on</default>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <context>http</context>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <context>server</context>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <context>location</context>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 <para>
1374
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
67 For the HTML <link id="autoindex_format">format</link>,
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
68 specifies whether exact file sizes should be output in the directory listing,
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 724
diff changeset
69 or rather rounded to kilobytes, megabytes, and gigabytes.
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 </para>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 </directive>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74
1374
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
75 <directive name="autoindex_format">
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
76 <syntax>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
77 <literal>html</literal> |
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
78 <literal>xml</literal> |
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
79 <literal>json</literal> |
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
80 <literal>jsonp</literal></syntax>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
81 <default>html</default>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
82 <context>http</context>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
83 <context>server</context>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
84 <context>location</context>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
85 <appeared-in>1.7.9</appeared-in>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
86
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
87 <para>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
88 Sets the format of a directory listing.
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
89 </para>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
90
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
91 <para>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
92 When the JSONP format is used, the name of a callback function is set
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
93 with the <literal>callback</literal> request argument.
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
94 If the argument is missing or has an empty value,
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
95 then the JSON format is used.
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
96 </para>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
97
1540
6866a74393e0 Added a hint about xslt transformation to autoindex_format.
Valentin Bartenev <vbart@nginx.com>
parents: 1374
diff changeset
98 <para>
6866a74393e0 Added a hint about xslt transformation to autoindex_format.
Valentin Bartenev <vbart@nginx.com>
parents: 1374
diff changeset
99 The XML output can be transformed using the
6866a74393e0 Added a hint about xslt transformation to autoindex_format.
Valentin Bartenev <vbart@nginx.com>
parents: 1374
diff changeset
100 <link doc="ngx_http_xslt_module.xml">ngx_http_xslt_module</link> module.
6866a74393e0 Added a hint about xslt transformation to autoindex_format.
Valentin Bartenev <vbart@nginx.com>
parents: 1374
diff changeset
101 </para>
6866a74393e0 Added a hint about xslt transformation to autoindex_format.
Valentin Bartenev <vbart@nginx.com>
parents: 1374
diff changeset
102
1374
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
103 </directive>
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
104
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
105
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 <directive name="autoindex_localtime">
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 <syntax><literal>on</literal> | <literal>off</literal></syntax>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 <default>off</default>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 <context>http</context>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110 <context>server</context>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <context>location</context>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <para>
1374
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
114 For the HTML <link id="autoindex_format">format</link>,
90922e31756d Documented the autoindex_format directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 966
diff changeset
115 specifies whether times in the directory listing should be
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 724
diff changeset
116 output in the local time zone or UTC.
315
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 </para>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 </directive>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 </section>
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122
e00f8f8c0486 Translated ngx_http_access_module, ngx_http_addition_module,
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 </module>