comparison xml/en/docs/stream/ngx_stream_js_module.xml @ 2773:a2852750c379

Added fetch directives to js http and stream modules.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 14 Oct 2021 18:53:16 +0100
parents 42fb92e582db
children 652356b39f0f
comparison
equal deleted inserted replaced
2772:91aaf82442e9 2773:a2852750c379
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_stream_js_module" 9 <module name="Module ngx_stream_js_module"
10 link="/en/docs/stream/ngx_stream_js_module.html" 10 link="/en/docs/stream/ngx_stream_js_module.html"
11 lang="en" 11 lang="en"
12 rev="28"> 12 rev="29">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_js_module</literal> module is used to implement 17 The <literal>ngx_stream_js_module</literal> module is used to implement
143 </para> 143 </para>
144 144
145 </directive> 145 </directive>
146 146
147 147
148 <directive name="js_fetch_ciphers">
149 <syntax><value>ciphers</value></syntax>
150 <default>HIGH:!aNULL:!MD5</default>
151 <context>stream</context>
152 <context>server</context>
153 <appeared-in>0.7.0</appeared-in>
154
155 <para>
156 Specifies the enabled ciphers for HTTPS connections
157 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
158 The ciphers are specified in the format understood by the OpenSSL library.
159 </para>
160
161 <para>
162 The full list can be viewed using the
163 “<command>openssl ciphers</command>” command.
164 </para>
165
166 </directive>
167
168
169 <directive name="js_fetch_protocols">
170 <syntax>
171 [<literal>TLSv1</literal>]
172 [<literal>TLSv1.1</literal>]
173 [<literal>TLSv1.2</literal>]
174 [<literal>TLSv1.3</literal>]</syntax>
175 <default>TLSv1 TLSv1.1 TLSv1.2</default>
176 <context>stream</context>
177 <context>server</context>
178 <appeared-in>0.7.0</appeared-in>
179
180 <para>
181 Enables the specified protocols for HTTPS connections
182 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
183 </para>
184
185 </directive>
186
187
188 <directive name="js_fetch_trusted_certificate">
189 <syntax><value>file</value></syntax>
190 <default/>
191 <context>stream</context>
192 <context>server</context>
193 <appeared-in>0.7.0</appeared-in>
194
195 <para>
196 Specifies a <value>file</value> with trusted CA certificates in the PEM format
197 used to
198 <link doc="../njs/reference.xml" id="fetch_verify">verify</link>
199 the HTTPS certificate
200 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
201 </para>
202
203 </directive>
204
205
206 <directive name="js_fetch_verify_depth">
207 <syntax><value>number</value></syntax>
208 <default>100</default>
209 <context>stream</context>
210 <context>server</context>
211 <appeared-in>0.7.0</appeared-in>
212
213 <para>
214 Sets the verification depth in the HTTPS server certificates chain
215 with <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
216 </para>
217
218 </directive>
219
220
148 <directive name="js_filter"> 221 <directive name="js_filter">
149 <syntax><value>function</value> | <value>module.function</value></syntax> 222 <syntax><value>function</value> | <value>module.function</value></syntax>
150 <default/> 223 <default/>
151 <context>stream</context> 224 <context>stream</context>
152 <context>server</context> 225 <context>server</context>