Mercurial > hg > nginx-site
annotate xml/en/docs/ngx_mgmt_module.xml @ 3029:27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 19 Dec 2023 12:58:01 +0000 |
parents | |
children | 6ffde2466d2d |
rev | line source |
---|---|
3029
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
2 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
3 <!-- |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
4 Copyright (C) Nginx, Inc. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
5 --> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
6 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
7 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
8 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
9 <module name="Module ngx_mgmt_module" |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
10 link="/en/docs/ngx_mgmt_module.html" |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
11 lang="en" |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
12 rev="1"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
13 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
14 <section id="summary"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
15 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
16 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
17 The <literal>ngx_mgmt_module</literal> module enables reporting of |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
18 current nginx installation to |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
19 <link url="https://docs.nginx.com/nginx-management-suite/about/">NGINX |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
20 Management Suite Instance Manager</link> (1.25.3). |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
21 By default, nginx sends usage info |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
22 to the Instance Manager located at <literal>nginx-mgmt.local</literal> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
23 every 30 minutes using the SSL connection. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
24 The system resolver is used unless |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
25 a <link id="resolver">custom resolver</link> is configured |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
26 and is invoked only once when the |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
27 configuration is <link doc="beginners_guide.xml" id="control">loaded</link>. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
28 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
29 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
30 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
31 <note> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
32 This module is available as part of our |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
33 <commercial_version>commercial subscription</commercial_version>. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
34 </note> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
35 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
36 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
37 </section> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
38 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
39 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
40 <section id="example" name="Example Configuration"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
41 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
42 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
43 <example> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
44 mgmt { |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
45 usage_report endpoint=nginx-mgmt.local interval=30m; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
46 resolver DNS_IP; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
47 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
48 uuid_file /var/lib/nginx/nginx.id; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
49 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
50 ssl_protocols TLSv1.2 TLSv1.3; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
51 ssl_ciphers DEFAULT; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
52 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
53 ssl_certificate client_cert.pem; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
54 ssl_certificate_key client_cert.key; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
55 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
56 # configure server certificate verification |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
57 # to validate the authenticity of NMS |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
58 ssl_trusted_certificate trusted_ca_cert.crt; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
59 ssl_verify on; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
60 ssl_verify_depth 2; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
61 } |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
62 </example> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
63 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
64 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
65 </section> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
66 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
67 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
68 <section id="directives" name="Directives"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
69 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
70 <directive name="connect_timeout"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
71 <syntax><value>time</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
72 <default>15s</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
73 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
74 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
75 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
76 Defines a timeout for establishing a connection with the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
77 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
78 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
79 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
80 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
81 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
82 <directive name="mgmt"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
83 <syntax block="yes"/> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
84 <default/> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
85 <context>main</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
86 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
87 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
88 Provides the configuration file context |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
89 in which the management server directives are specified. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
90 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
91 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
92 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
93 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
94 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
95 <directive name="read_timeout"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
96 <syntax><value>time</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
97 <default>60s</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
98 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
99 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
100 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
101 Defines a timeout for reading a response from the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
102 The timeout is set only between two successive read operations, |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
103 not for the transmission of the whole response. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
104 If the Instance Manager does not transmit anything within this time, |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
105 the connection is closed. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
106 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
107 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
108 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
109 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
110 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
111 <directive name="resolver"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
112 <syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
113 <value>address</value> ... |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
114 [<literal>valid</literal>=<value>time</value>] |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
115 [<literal>ipv4</literal>=<literal>on</literal>|<literal>off</literal>] |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
116 [<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>] |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
117 [<literal>status_zone</literal>=<value>zone</value>]</syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
118 <default/> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
119 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
120 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
121 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
122 Configures name servers used to resolve names of the Instance Manager |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
123 into addresses, for example: |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
124 <example> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
125 resolver 127.0.0.1 [::1]:5353; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
126 </example> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
127 The address can be specified as a domain name or IP address, |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
128 with an optional port. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
129 If port is not specified, the port 53 is used. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
130 Name servers are queried in a round-robin fashion. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
131 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
132 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
133 <para id="resolver_ipv6"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
134 By default, nginx will look up both IPv4 and IPv6 addresses while resolving. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
135 If looking up of IPv4 or IPv6 addresses is not desired, |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
136 the <literal>ipv4=off</literal> or |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
137 the <literal>ipv6=off</literal> parameter can be specified. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
138 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
139 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
140 <para id="resolver_valid"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
141 By default, nginx caches answers using the TTL value of a response. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
142 An optional <literal>valid</literal> parameter allows overriding it: |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
143 <example> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
144 resolver 127.0.0.1 [::1]:5353 valid=30s; |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
145 </example> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
146 <note> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
147 To prevent DNS spoofing, it is recommended |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
148 configuring DNS servers in a properly secured trusted local network. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
149 </note> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
150 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
151 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
152 <para id="resolver_status_zone"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
153 The optional <literal>status_zone</literal> parameter |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
154 enables |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
155 <link doc="ngx_http_api_module.xml" id="resolvers_">collection</link> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
156 of DNS server statistics of requests and responses |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
157 in the specified <value>zone</value>. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
158 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
159 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
160 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
161 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
162 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
163 <directive name="resolver_timeout"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
164 <syntax><value>time</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
165 <default>30s</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
166 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
167 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
168 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
169 Sets a timeout for name resolution. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
170 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
171 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
172 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
173 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
174 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
175 <directive name="send_timeout"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
176 <syntax><value>time</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
177 <default>60s</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
178 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
179 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
180 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
181 Sets a timeout for transmitting a request to the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
182 The timeout is set only between two successive write operations, |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
183 not for the transmission of the whole request. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
184 If the Instance Manager does not receive anything within this time, |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
185 the connection is closed. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
186 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
187 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
188 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
189 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
190 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
191 <directive name="ssl"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
192 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
193 <default>on</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
194 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
195 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
196 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
197 Enables the HTTPS protocol for all |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
198 connections to the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
199 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
200 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
201 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
202 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
203 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
204 <directive name="ssl_certificate"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
205 <syntax><value>file</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
206 <default/> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
207 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
208 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
209 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
210 Specifies a <value>file</value> with the certificate in the PEM format |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
211 used for authentication to the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
212 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
213 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
214 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
215 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
216 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
217 <directive name="ssl_certificate_key"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
218 <syntax><value>file</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
219 <default/> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
220 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
221 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
222 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
223 Specifies a <value>file</value> with the secret key in the PEM format |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
224 used for authentication to the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
225 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
226 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
227 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
228 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
229 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
230 <directive name="ssl_ciphers"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
231 <syntax><value>ciphers</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
232 <default>DEFAULT</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
233 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
234 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
235 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
236 Specifies the enabled ciphers for requests to the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
237 The ciphers are specified in the format understood by the OpenSSL library. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
238 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
239 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
240 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
241 The full list can be viewed using the |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
242 “<command>openssl ciphers</command>” command. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
243 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
244 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
245 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
246 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
247 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
248 <directive name="ssl_crl"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
249 <syntax><value>file</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
250 <default/> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
251 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
252 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
253 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
254 Specifies a <value>file</value> with revoked certificates (CRL) |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
255 in the PEM format used to <link id="ssl_verify">verify</link> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
256 the certificate of the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
257 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
258 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
259 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
260 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
261 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
262 <directive name="ssl_name"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
263 <syntax><value>name</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
264 <default>ssl_name host</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
265 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
266 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
267 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
268 Allows overriding the server name used to |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
269 <link id="ssl_verify">verify</link> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
270 the certificate of the Instance Manager and to be |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
271 <link id="ssl_server_name">passed through SNI</link> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
272 when establishing a connection with the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
273 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
274 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
275 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
276 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
277 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
278 <directive name="ssl_password_file"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
279 <syntax><value>file</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
280 <default/> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
281 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
282 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
283 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
284 Specifies a <value>file</value> with passphrases for |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
285 <link id="ssl_certificate_key">secret keys</link> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
286 where each passphrase is specified on a separate line. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
287 Passphrases are tried in turn when loading the key. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
288 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
289 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
290 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
291 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
292 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
293 <directive name="ssl_protocols"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
294 <syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
295 [<literal>SSLv2</literal>] |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
296 [<literal>SSLv3</literal>] |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
297 [<literal>TLSv1</literal>] |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
298 [<literal>TLSv1.1</literal>] |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
299 [<literal>TLSv1.2</literal>] |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
300 [<literal>TLSv1.3</literal>]</syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
301 <default>TLSv1 TLSv1.1 TLSv1.2 TLSv1.3</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
302 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
303 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
304 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
305 Enables the specified protocols for requests to the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
306 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
307 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
308 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
309 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
310 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
311 <directive name="ssl_server_name"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
312 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
313 <default>off</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
314 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
315 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
316 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
317 Enables or disables passing of the server name through |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
318 <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">TLS |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
319 Server Name Indication extension</link> (SNI, RFC 6066) |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
320 when establishing a connection with the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
321 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
322 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
323 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
324 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
325 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
326 <directive name="ssl_trusted_certificate"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
327 <syntax><value>file</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
328 <default/> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
329 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
330 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
331 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
332 Specifies a <value>file</value> with trusted CA certificates in the PEM format |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
333 used to <link id="ssl_verify">verify</link> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
334 the certificate of the Instance Manager. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
335 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
336 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
337 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
338 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
339 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
340 <directive name="ssl_verify"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
341 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
342 <default>off</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
343 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
344 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
345 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
346 Enables or disables verification of the Instance Manager certificate. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
347 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
348 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
349 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
350 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
351 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
352 <directive name="ssl_verify_depth"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
353 <syntax><value>number</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
354 <default>1</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
355 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
356 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
357 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
358 Sets the verification depth in the Instance Manager certificates chain. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
359 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
360 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
361 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
362 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
363 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
364 <directive name="usage_report"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
365 <syntax> [<literal>endpoint</literal>=<value>address</value>] |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
366 [<literal>interval</literal>=<value>time</value>]</syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
367 <default/> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
368 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
369 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
370 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
371 Sets the <value>address</value> and <value>port</value> for IP, |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
372 or the <value>path</value> for a UNIX-domain socket on which |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
373 the Instance Manager is installed, |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
374 by default <literal>nginx-mgmt.local</literal>. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
375 The <literal>interval</literal> sets an interval between reports |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
376 to the Instance Manager, by default 30m. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
377 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
378 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
379 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
380 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
381 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
382 <directive name="uuid_file"> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
383 <syntax><value>file</value></syntax> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
384 <default>logs/uuid</default> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
385 <context>mgmt</context> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
386 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
387 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
388 Specifies a <value>file</value> that keeps the ID of nginx instance. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
389 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
390 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
391 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
392 Examples: |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
393 <example> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
394 state /var/lib/nginx/nginx.id; # path for Linux |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
395 state /var/db/nginx/nginx.id; # path for FreeBSD |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
396 </example> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
397 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
398 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
399 <para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
400 Changing the file content directly should be avoided. |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
401 </para> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
402 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
403 </directive> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
404 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
405 </section> |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
406 |
27008cb3fb27
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
407 </module> |