comparison xml/en/docs/http/ngx_http_ssl_module.xml @ 2068:3d9e7993c201

Added links to directives in the example of ssl modules.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 23 Oct 2017 14:48:21 +0300
parents 093855e77388
children aa5d65fe4916
comparison
equal deleted inserted replaced
2067:014323d0cc38 2068:3d9e7993c201
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_ssl_module" 10 <module name="Module ngx_http_ssl_module"
11 link="/en/docs/http/ngx_http_ssl_module.html" 11 link="/en/docs/http/ngx_http_ssl_module.html"
12 lang="en" 12 lang="en"
13 rev="36"> 13 rev="37">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_ssl_module</literal> module provides the 18 The <literal>ngx_http_ssl_module</literal> module provides the
37 <para> 37 <para>
38 To reduce the processor load it is recommended to 38 To reduce the processor load it is recommended to
39 <list type="bullet"> 39 <list type="bullet">
40 40
41 <listitem> 41 <listitem>
42 set the number of worker processes equal to the number of processors, 42 set the number of
43 <link doc="../ngx_core_module.xml" id="worker_processes">worker processes</link>
44 equal to the number of processors,
43 </listitem> 45 </listitem>
44 46
45 <listitem> 47 <listitem>
46 enable keep-alive connections, 48 enable
49 <link doc="ngx_http_core_module.xml" id="keepalive_timeout">keep-alive</link>
50 connections,
47 </listitem> 51 </listitem>
48 52
49 <listitem> 53 <listitem>
50 enable the shared session cache, 54 enable the <link id="ssl_session_cache_shared">shared</link> session cache,
51 </listitem> 55 </listitem>
52 56
53 <listitem> 57 <listitem>
54 disable the built-in session cache, 58 disable the <link id="ssl_session_cache_builtin">built-in</link> session cache,
55 </listitem> 59 </listitem>
56 60
57 <listitem> 61 <listitem>
58 and possibly increase the session lifetime (by default, 5 minutes): 62 and possibly increase the session <link id="ssl_session_timeout">lifetime</link>
63 (by default, 5 minutes):
59 </listitem> 64 </listitem>
60 65
61 </list> 66 </list>
62 67
63 <example> 68 <example>
428 the use of a session cache is gently disallowed: 433 the use of a session cache is gently disallowed:
429 nginx tells a client that sessions may be reused, but does not 434 nginx tells a client that sessions may be reused, but does not
430 actually store session parameters in the cache. 435 actually store session parameters in the cache.
431 </tag-desc> 436 </tag-desc>
432 437
433 <tag-name><literal>builtin</literal></tag-name> 438 <tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name>
434 <tag-desc> 439 <tag-desc>
435 a cache built in OpenSSL; used by one worker process only. 440 a cache built in OpenSSL; used by one worker process only.
436 The cache size is specified in sessions. 441 The cache size is specified in sessions.
437 If size is not given, it is equal to 20480 sessions. 442 If size is not given, it is equal to 20480 sessions.
438 Use of the built-in cache can cause memory fragmentation. 443 Use of the built-in cache can cause memory fragmentation.
439 </tag-desc> 444 </tag-desc>
440 445
441 <tag-name><literal>shared</literal></tag-name> 446 <tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name>
442 <tag-desc> 447 <tag-desc>
443 a cache shared between all worker processes. 448 a cache shared between all worker processes.
444 The cache size is specified in bytes; one megabyte can store 449 The cache size is specified in bytes; one megabyte can store
445 about 4000 sessions. 450 about 4000 sessions.
446 Each shared cache should have an arbitrary name. 451 Each shared cache should have an arbitrary name.