Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_referer_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 a8a643647c76
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 502
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 502
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 502
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 502
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 502
diff changeset
7
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_referer_module"
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_referer_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
1157
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
13 rev="2">
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="summary">
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 659
diff changeset
18 The <literal>ngx_http_referer_module</literal> module is used to block
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 access to a site for requests with invalid values in the
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 <header>Referer</header> header field.
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 It should be kept in mind that fabricating a request with an appropriate
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 <header>Referer</header> field value is quite easy, and so the intended
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 purpose of this module is not to block such requests thoroughly but to block
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 the mass flow of requests sent by regular browsers.
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 It should also be taken into consideration that regular browsers may
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 not send the <header>Referer</header> field even for valid requests.
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 </para>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 </section>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 <section id="example" name="Example Configuration">
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <para>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 <example>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 valid_referers none blocked server_names
490
9913f1d51c07 Replaced "nginx" domain names with example domains.
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
37 *.example.com example.* www.example.org/galleries/
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 ~\.google\.;
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 if ($invalid_referer) {
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 return 403;
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 }
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 </example>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 </para>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 </section>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <section id="directives" name="Directives">
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50
502
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
51 <directive name="referer_hash_bucket_size">
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
52 <syntax><value>size</value></syntax>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
53 <default>64</default>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
54 <context>server</context>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
55 <context>location</context>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
56 <appeared-in>1.0.5</appeared-in>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
57
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
58 <para>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
59 Sets the bucket size for the valid referers hash tables.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 659
diff changeset
60 The details of setting up hash tables are provided in a separate
659
77a3314c74a7 Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents: 589
diff changeset
61 <link doc="../hash.xml">document</link>.
502
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
62 </para>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
63
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
64 </directive>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
65
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
66
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
67 <directive name="referer_hash_max_size">
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
68 <syntax><value>size</value></syntax>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
69 <default>2048</default>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
70 <context>server</context>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
71 <context>location</context>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
72 <appeared-in>1.0.5</appeared-in>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
73
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
74 <para>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
75 Sets the maximum <value>size</value> of the valid referers hash tables.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 659
diff changeset
76 The details of setting up hash tables are provided in a separate
659
77a3314c74a7 Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents: 589
diff changeset
77 <link doc="../hash.xml">document</link>.
502
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
78 </para>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
79
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
80 </directive>
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
81
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
82
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 <directive name="valid_referers">
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 <syntax>
364
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 357
diff changeset
85 <literal>none</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 357
diff changeset
86 <literal>blocked</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 357
diff changeset
87 <literal>server_names</literal> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 357
diff changeset
88 <value>string</value>
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 357
diff changeset
89 ...</syntax>
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <default/>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 <context>server</context>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 <context>location</context>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <para>
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 659
diff changeset
95 Specifies the <header>Referer</header> request header field values
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 659
diff changeset
96 that will cause the embedded <var>$invalid_referer</var> variable to
502
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
97 be set to an empty string.
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
98 Otherwise, the variable will be set to “<literal>1</literal>”.
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
99 Search for a match is case-insensitive.
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 </para>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 <para>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 Parameters can be as follows:
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 <list type="tag">
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 <tag-name><literal>none</literal></tag-name>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 <tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 the <header>Referer</header> field is missing in the request header;
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 </tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <tag-name><literal>blocked</literal></tag-name>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 the <header>Referer</header> field is present in the request header,
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 659
diff changeset
114 but its value has been deleted by a firewall or proxy server;
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 659
diff changeset
115 such values are strings that do not start with
502
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
116 “<literal>http://</literal>” or “<literal>https://</literal>”;
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 </tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 <tag-name><literal>server_names</literal></tag-name>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 <tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 the <header>Referer</header> request header field contains
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 one of the server names;
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 </tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 <tag-name>arbitrary string</tag-name>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 <tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 defines a server name and an optional URI prefix.
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 A server name can have an “<literal>*</literal>” at the beginning or end.
966
95c3c3bbf1ce Text review.
Egor Nikitin <yegor.nikitin@gmail.com>
parents: 659
diff changeset
129 During the checking, the server’s port in the <header>Referer</header> field
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130 is ignored;
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131 </tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133 <tag-name>regular expression</tag-name>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134 <tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 the first symbol should be a “<literal>~</literal>”.
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136 It should be noted that an expression will be matched against
502
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
137 the text starting after the “<literal>http://</literal>”
6520338cdf0a Bring ngx_http_referer_module docs up to date, including:
Ruslan Ermilov <ru@nginx.com>
parents: 490
diff changeset
138 or “<literal>https://</literal>”.
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139 </tag-desc>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141 </list>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 </para>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 <para>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145 Example:
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 <example>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 valid_referers none blocked server_names
490
9913f1d51c07 Replaced "nginx" domain names with example domains.
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
148 *.example.com example.* www.example.org/galleries/
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 ~\.google\.;
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 </example>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 </para>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 </directive>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155 </section>
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156
1157
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
157
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
158 <section id="variables" name="Embedded Variables">
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
159
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
160 <para>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
161 <list type="tag">
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
162
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
163 <tag-name id="var_invalid_referer"><var>$invalid_referer</var></tag-name>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
164 <tag-desc>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
165 Empty string, if the <header>Referer</header> request header field
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
166 value is considered
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
167 <link id="valid_referers">valid</link>, otherwise “<literal>1</literal>”.
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
168 </tag-desc>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
169
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
170 </list>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
171 </para>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
172
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
173 </section>
a8a643647c76 Added descriptions for $invalid_referer and $memcached_key.
Vladimir Homutov <vl@nginx.com>
parents: 966
diff changeset
174
357
3d6c27e22625 Translated ngx_http_referer_module into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 </module>