Skip to content

Commit 3aad6b0

Browse files
y82y82
committed
Updated docs for the upcoming NGINX Plus release.
1 parent 926fe8f commit 3aad6b0

18 files changed

+543
-266
lines changed

‎xml/en/docs/configure.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ enables building a module that provides support for
238238
This module is not built by default.
239239
</tag-desc>
240240

241-
<tag-name id="http_v3_module">
241+
<tag-name>
242242
<literal>--with-http_v3_module</literal>
243243
</tag-name>
244244
<tag-desc>

‎xml/en/docs/http/ngx_http_api_module.xml‎

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<module name="Module ngx_http_api_module"
1010
link="/en/docs/http/ngx_http_api_module.html"
1111
lang="en"
12-
rev="3">
12+
rev="4">
1313

1414
<section id="summary">
1515

@@ -208,6 +208,11 @@ redirect</link> happens during request processing.
208208
<para>
209209
<list type="bullet">
210210

211+
<listitem>
212+
The <link id="license">/license</link> data
213+
were added in <link id="api_version">version</link> 9 (1.27.2).
214+
</listitem>
215+
211216
<listitem>
212217
The <link id="workers_">/workers/</link> data
213218
were added in <link id="api_version">version</link> 9.
@@ -298,6 +303,8 @@ were added in <link id="api_version">version</link> 2.
298303
</para>
299304

300305
</section>
306+
307+
301308
<section id="endpoints" name="Endpoints">
302309
<para>
303310
<list type="tag">
@@ -2015,6 +2022,25 @@ Possible responses:
20152022
</listitem>
20162023
</list>
20172024
</tag-desc>
2025+
<tag-name id="license" name="/license">
2026+
<literal>/license</literal>
2027+
</tag-name>
2028+
<tag-desc>
2029+
<para>Supported methods:</para>
2030+
<list type="bullet" compact="yes">
2031+
<listitem id="getLicense">
2032+
<literal>GET</literal> - Return license info
2033+
<para></para>
2034+
<para>
2035+
Possible responses:
2036+
</para>
2037+
<list type="bullet">
2038+
<listitem>200 - Success, returns <link id="def_nginx_license_object">License</link></listitem>
2039+
<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2040+
</list>
2041+
</listitem>
2042+
</list>
2043+
</tag-desc>
20182044
<tag-name id="workers_" name="/workers/">
20192045
<literal>/workers/</literal>
20202046
</tag-name>
@@ -4445,6 +4471,58 @@ The total number of requests completed with an unknown error.
44454471
}
44464472
}</example>
44474473
</listitem>
4474+
<listitem id="def_nginx_license_object">
4475+
<para>License:</para>
4476+
License and usage reporting status of NGINX Plus instance.<list type="tag">
4477+
<tag-name>
4478+
<literal>eval</literal> (<literal>boolean</literal>)
4479+
</tag-name>
4480+
<tag-desc>
4481+
Indicates whether NGINX Plus license is trial.
4482+
</tag-desc>
4483+
<tag-name>
4484+
<literal>active_till</literal> (<literal>integer</literal>)
4485+
</tag-name>
4486+
<tag-desc>
4487+
The Unix timestamp of license expiration.
4488+
</tag-desc>
4489+
<tag-name>
4490+
<literal>reporting</literal></tag-name>
4491+
<tag-desc>
4492+
<list type="tag">
4493+
<tag-name>
4494+
<literal>healthy</literal> (<literal>boolean</literal>)
4495+
</tag-name>
4496+
<tag-desc>
4497+
Indicates whether the reporting state is still considered healthy despite recent failed attempts.
4498+
</tag-desc>
4499+
<tag-name>
4500+
<literal>fails</literal> (<literal>integer</literal>)
4501+
</tag-name>
4502+
<tag-desc>
4503+
The number of failed reporting attempts, reset each time the usage report is successfully sent.
4504+
</tag-desc>
4505+
<tag-name>
4506+
<literal>grace</literal> (<literal>integer</literal>)
4507+
</tag-name>
4508+
<tag-desc>
4509+
The number of seconds before traffic processing is stopped after unsuccessful report attempt.
4510+
</tag-desc>
4511+
</list>
4512+
</tag-desc>
4513+
</list>
4514+
<para>Example:</para>
4515+
<example>
4516+
{
4517+
"eval" : false,
4518+
"active_till" : 1749268757,
4519+
"reporting" : {
4520+
"healthy" : true,
4521+
"fails" : 2,
4522+
"grace" : 15551961
4523+
}
4524+
}</example>
4525+
</listitem>
44484526
<listitem id="def_nginx_worker">
44494527
<para>Worker process:</para>
44504528
Statistics per each worker process.<list type="tag">

‎xml/en/docs/http/ngx_http_api_module_head.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,11 @@ redirect</link> happens during request processing.
208208
<para>
209209
<list type="bullet">
210210

211+
<listitem>
212+
The <link id="license">/license</link> data
213+
were added in <link id="api_version">version</link> 9 (1.27.2).
214+
</listitem>
215+
211216
<listitem>
212217
The <link id="workers_">/workers/</link> data
213218
were added in <link id="api_version">version</link> 9.

‎xml/en/docs/http/ngx_http_grpc_module.xml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,32 @@ the certificate of the gRPC SSL server.
588588
</directive>
589589

590590

591+
<directive name="grpc_ssl_key_log">
592+
<syntax>path</syntax>
593+
<default/>
594+
<context>http</context>
595+
<context>server</context>
596+
<context>location</context>
597+
<appeared-in>1.27.2</appeared-in>
598+
599+
<para>
600+
Enables logging of gRPC SSL server connection SSL keys
601+
and specifies the path to the key log file.
602+
Keys are logged in the
603+
<link url="https://datatracker.ietf.org/doc/html/draft-ietf-tls-keylogfile">SSLKEYLOGFILE</link>
604+
format compatible with Wireshark.
605+
</para>
606+
607+
<para>
608+
<note>
609+
This directive is available as part of our
610+
<commercial_version>commercial subscription</commercial_version>.
611+
</note>
612+
</para>
613+
614+
</directive>
615+
616+
591617
<directive name="grpc_ssl_name">
592618
<syntax><value>name</value></syntax>
593619
<default>host from grpc_pass</default>

‎xml/en/docs/http/ngx_http_proxy_module.xml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2081,6 +2081,32 @@ the certificate of the proxied HTTPS server.
20812081
</directive>
20822082

20832083

2084+
<directive name="proxy_ssl_key_log">
2085+
<syntax>path</syntax>
2086+
<default/>
2087+
<context>http</context>
2088+
<context>server</context>
2089+
<context>location</context>
2090+
<appeared-in>1.27.2</appeared-in>
2091+
2092+
<para>
2093+
Enables logging of proxied HTTPS server connection SSL keys
2094+
and specifies the path to the key log file.
2095+
Keys are logged in the
2096+
<link url="https://datatracker.ietf.org/doc/html/draft-ietf-tls-keylogfile">SSLKEYLOGFILE</link>
2097+
format compatible with Wireshark.
2098+
</para>
2099+
2100+
<para>
2101+
<note>
2102+
This directive is available as part of our
2103+
<commercial_version>commercial subscription</commercial_version>.
2104+
</note>
2105+
</para>
2106+
2107+
</directive>
2108+
2109+
20842110
<directive name="proxy_ssl_name">
20852111
<syntax><value>name</value></syntax>
20862112
<default>$proxy_host</default>

‎xml/en/docs/http/ngx_http_ssl_module.xml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,31 @@ it is important to include the curves used in the certificates.
448448
</directive>
449449

450450

451+
<directive name="ssl_key_log">
452+
<syntax>path</syntax>
453+
<default/>
454+
<context>http</context>
455+
<context>server</context>
456+
<appeared-in>1.27.2</appeared-in>
457+
458+
<para>
459+
Enables logging of client connection SSL keys
460+
and specifies the path to the key log file.
461+
Keys are logged in the
462+
<link url="https://datatracker.ietf.org/doc/html/draft-ietf-tls-keylogfile">SSLKEYLOGFILE</link>
463+
format compatible with Wireshark.
464+
</para>
465+
466+
<para>
467+
<note>
468+
This directive is available as part of our
469+
<commercial_version>commercial subscription</commercial_version>.
470+
</note>
471+
</para>
472+
473+
</directive>
474+
475+
451476
<directive name="ssl_ocsp">
452477
<syntax><literal>on</literal> |
453478
<literal>off</literal> |

‎xml/en/docs/http/ngx_http_uwsgi_module.xml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1498,6 +1498,32 @@ the certificate of the secured uwsgi server.
14981498
</directive>
14991499

15001500

1501+
<directive name="uwsgi_ssl_key_log">
1502+
<syntax>path</syntax>
1503+
<default/>
1504+
<context>http</context>
1505+
<context>server</context>
1506+
<context>location</context>
1507+
<appeared-in>1.27.2</appeared-in>
1508+
1509+
<para>
1510+
Enables logging of secured uwsgi server connection SSL keys
1511+
and specifies the path to the key log file.
1512+
Keys are logged in the
1513+
<link url="https://datatracker.ietf.org/doc/html/draft-ietf-tls-keylogfile">SSLKEYLOGFILE</link>
1514+
format compatible with Wireshark.
1515+
</para>
1516+
1517+
<para>
1518+
<note>
1519+
This directive is available as part of our
1520+
<commercial_version>commercial subscription</commercial_version>.
1521+
</note>
1522+
</para>
1523+
1524+
</directive>
1525+
1526+
15011527
<directive name="uwsgi_ssl_name">
15021528
<syntax><value>name</value></syntax>
15031529
<default>host from uwsgi_pass</default>

0 commit comments

Comments
 (0)