comparison xml/ru/docs/http/ngx_http_secure_link_module.xml @ 76:4a4caa566120

Russian documentation import. Changes in module.dtd: <example> now allowed to contain <value> and <emphasis> elements (we need this to show important parts in examples), less strict checking of <directive> syntax (we don't want to fully document some directives, notably deprecated ones). Known issues: 1. <syntax> elements are preserved as is, they will require manual conversion (likely to some not-yet-existed format a la DocBook cmdsynopsis, as currently used one seems to be incomplete); 2. <value> no longer corresponds to replaceable content, and it's use in examples isn't correct; 3. <link doc="document#fragment"> doesn't work with current xslt, either should be supported or changed to <link doc="document" id="fragment">. The following files are intentionally omitted: maillists.xml (support.xml should be used instead), experimental.xml (obsolete), faq.xml (conflicts with existing one, needs discussion). Not yet linked to site.
author Maxim Dounin <mdounin@mdounin.ru>
date Tue, 11 Oct 2011 12:57:50 +0000
parents
children 1d315ef37215
comparison
equal deleted inserted replaced
75:2bf4cd2787c5 76:4a4caa566120
1 <?xml version="1.0" encoding="utf-8"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Директивы модуля ngx_http_secure_link_module"
6 link="/ru/docs/http/ngx_http_secure_link_module.html"
7 lang="ru">
8
9 <section name="" id="summary">
10
11 <para>
12 Модуль ngx_http_secure_link_module — это модуль проверяющий
13 правильность запрашиваемой ссылки (0.7.18+).
14 По умолчанию модуль не собирается, нужно разрешить его сборку
15 при конфигурировании параметром
16 <command>--with-http_secure_link_module</command>.
17 </para>
18
19 </section>
20
21
22 <section name="Пример конфигурации" id="example">
23
24 <para>
25 <example>
26 location /p/ {
27 secure_link_secret some_secret_word;
28
29 if ($secure_link = "") {
30 return 403;
31 }
32 }
33 </example>
34 </para>
35
36 </section>
37
38
39 <section name="Директивы" id="directives">
40
41 <directive name="secure_link_secret">
42 <syntax>secure_link_secret <value>слово</value></syntax>
43 <default>нет</default>
44 <context>location</context>
45
46 <para>
47 Директива задаёт секретное слово для проверки правильности ссылки.
48 Полный URL защищённой ссылки вглядит так:
49 <example>
50 /prefix/<value>hash</value>/<value>ссылка</value>
51 </example>
52 где hash считается как
53 <example>
54 md5(ссылка, секретное_слово);
55 </example>
56 </para>
57
58 <para>
59 Префикс — произвольная строка, не включающая слэш.
60 </para>
61
62 </directive>
63
64 </section>
65
66
67 <section name="Встроенные переменные" id="variables">
68
69 <para>
70 <list type="bullet">
71
72 <listitem>
73 $secure_link, эта переменная равна ссылке выделенной из полного URL'а.
74 Если хэш неверный, то переменная равна пустой строке.
75 </listitem>
76
77 </list>
78 </para>
79
80 </section>
81
82 </module>