Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_random_index_module.xml @ 3011:55d49eb065ac

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed example in the js_periodic directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 14 Sep 2023 16:38:00 +0100
parents 95c3c3bbf1ce
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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_random_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_random_index_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
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>
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_random_index_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 picks a random
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 724
diff changeset
20 file in a directory to serve as an index file.
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 724
diff changeset
21 The module is processed before the
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 <link doc="ngx_http_index_module.xml">ngx_http_index_module</link>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 module.
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 </para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 <para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 This module is not built by default, it should be enabled with the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 222
diff changeset
28 <literal>--with-http_random_index_module</literal>
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 configuration parameter.
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 </para>
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 </section>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34
320
197ac51e7f0e Changed attributes order.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
35 <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
36
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 <para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 <example>
351
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 320
diff changeset
39 location / {
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 320
diff changeset
40 random_index on;
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 320
diff changeset
41 }
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 </example>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 </para>
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 </section>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
320
197ac51e7f0e Changed attributes order.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
48 <section id="directives" name="Directives">
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <directive name="random_index">
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 222
diff changeset
51 <syntax><literal>on</literal> | <literal>off</literal></syntax>
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 <default>off</default>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <context>location</context>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 <para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 Enables or disables module processing in a surrounding location.
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 </para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 </directive>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 </section>
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 </module>