Skip to content

Commit 2e6c79d

Browse files
committed
Update http_grpc
1 parent b930bf5 commit 2e6c79d

File tree

1 file changed

+161
-1
lines changed

1 file changed

+161
-1
lines changed

模块参考/http/ngx_http_grpc_module.md

Lines changed: 161 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,167 @@ grpc_pass grpcs://127.0.0.1:443;
248248

249249
允许从 gRPC 服务器向客户端传递忽略的头字段。
250250

251-
**待续……**
251+
### grpc_read_timeout
252+
253+
|\-|说明|
254+
|------:|------|
255+
|**语法**|**grpc_read_timeout** `time`;|
256+
|**默认**|grpc_read_timeout 60s;|
257+
|**上下文**|http、server、location|
258+
259+
定义从 gRPC 服务器读取响应的超时时间。超时间隔只在两次连续的读操作之间,而不是整个响应的传输过程。如果 gRPC 服务器在此时间内没有发送任何内容,则连接关闭。
260+
261+
### grpc_send_timeout
262+
263+
|\-|说明|
264+
|------:|------|
265+
|**语法**|**grpc_send_timeout** `time`;|
266+
|**默认**|grpc_send_timeout 60s;|
267+
|**上下文**|http、server、location|
268+
269+
设置向 gRPC 服务器发送请求的超时时间。超时间隔只在两次连续写入操作之间,而不是整个请求的传输过程。如果 gRPC 服务器在此时间内没有收到任何内容,则连接将关闭。
270+
271+
### grpc_set_header
272+
273+
|\-|说明|
274+
|------:|------|
275+
|**语法**|**grpc_set_header** `field value`;|
276+
|**默认**|grpc_set_header Content-Length $content_length;|
277+
|**上下文**|http、server、location|
278+
279+
允许重新定义或附加字段到[传递](#grpc_pass_request_headers)给 gRPC 服务器的请求头。该值可以包含文本、变量及其组合。当且仅当在当前级别上没有定义 `grpc_set_header` 指令时,这些指令才从上一级继承。
280+
281+
如果头字段的值是一个空字符串,那么这个字段将不会被传递给 gRPC 服务器:
282+
283+
```nginx
284+
grpc_set_header Accept-Encoding "";
285+
```
286+
287+
### grpc_ssl_certificate
288+
289+
|\-|说明|
290+
|------:|------|
291+
|**语法**|**grpc_ssl_certificate** `file`;|
292+
|**默认**|——|
293+
|**上下文**|http、server、location|
294+
295+
指定一个带有 PEM 格式证书的文件(`file`),用于向 gRPC SSL 服务器进行身份验证。
296+
297+
### grpc_ssl_certificate_key
298+
299+
|\-|说明|
300+
|------:|------|
301+
|**语法**|**grpc_ssl_certificate_key** `file`;|
302+
|**默认**|——|
303+
|**上下文**|http、server、location|
304+
305+
指定一个文件(`file`),其包含 PEM 格式的密钥,用于对 gRPC SSL 服务器进行身份验证。
306+
307+
可以指定值 `engine:name:id` 来代替 `file`,其从 OpenSSL 引擎 `name` 加载具有指定 `id` 的密钥。
308+
309+
### grpc_ssl_ciphers
310+
311+
|\-|说明|
312+
|------:|------|
313+
|**语法**|**grpc_ssl_ciphers** `ciphers`;|
314+
|**默认**|grpc_ssl_ciphers DEFAULT;|
315+
|**上下文**|http、server、location|
316+
317+
指定对 gRPC SSL 服务器的请求启用的密码。密码格式能被 OpenSSL 库所支持。
318+
319+
完整的列表详情可以使用 `openssl ciphers` 命令查看。
320+
321+
### grpc_ssl_crl
322+
323+
|\-|说明|
324+
|------:|------|
325+
|**语法**|**grpc_ssl_crl** `file`;|
326+
|**默认**|——|
327+
|**上下文**|http、server、location|
328+
329+
指定一个带有 PEM 格式的撤销证书(CRL)的文件(`file`),用于[验证](#grpc_ssl_verify) gRPC SSL 服务器的证书。
330+
331+
### grpc_ssl_name
332+
333+
|\-|说明|
334+
|------:|------|
335+
|**语法**|**grpc_ssl_name** `name`;|
336+
|**默认**|grpc_ssl_name host from grpc_pass;|
337+
|**上下文**|http、server、location|
338+
339+
允许重写用于[验证](#grpc_ssl_verify) gRPC SSL 服务器的证书并在与 gRPC SSL 服务器建立连接时[通过 SNI 传递](#grpc_ssl_server_name)的服务器名称。
340+
341+
默认情况下,使用 [grpc_pass](#grpc_pass) 的主机部分。
342+
343+
### grpc_ssl_password_file
344+
345+
|\-|说明|
346+
|------:|------|
347+
|**语法**|**grpc_ssl_password_file** `file`;|
348+
|**默认**|——|
349+
|**上下文**|http、server、location|
350+
351+
指定一个密码为密钥的文件,[每个密码](#grpc_ssl_certificate_key)在单独的行上指定。加载密钥时会依次尝试每个密码。
352+
353+
### grpc_ssl_server_name
354+
355+
|\-|说明|
356+
|------:|------|
357+
|**语法**|**grpc_ssl_server_name** `on` | `off`;|
358+
|**默认**|grpc_ssl_server_name off;|
359+
|**上下文**|http、server、location|
360+
361+
在建立与 gRPC SSL 服务器的连接时,启用或禁用通过 [TLS 服务器名称指示扩展](http://en.wikipedia.org/wiki/Server_Name_Indication)(SNI,RFC 6066)传送服务器名称。
362+
363+
### grpc_ssl_session_reuse
364+
365+
|\-|说明|
366+
|------:|------|
367+
|**语法**|**grpc_ssl_session_reuse** `on` | `off`;|
368+
|**默认**|grpc_ssl_session_reuse on;|
369+
|**上下文**|http、server、location|
370+
371+
确定在使用 gRPC 服务器时是否可以重用 SSL 会话。如果错误 `SSL3_GET_FINISHED:digest check fialed` 出现在日志中,尝试禁用会话重用。
372+
373+
### grpc_ssl_protocols
374+
375+
|\-|说明|
376+
|------:|------|
377+
|**语法**|**grpc_ssl_protocols** `[SSLv2] [SSLv3] [TLSv1] [TLSv1.1] [TLSv1.2] [TLSv1.3]`;|
378+
|**默认**|grpc_ssl_protocols TLSv1 TLSv1.1 TLSv1.2;|
379+
|**上下文**|http、server、location|
380+
381+
对 gRPC SSL 服务器的请求启用指定的协议。
382+
383+
### grpc_ssl_trusted_certificate
384+
385+
|\-|说明|
386+
|------:|------|
387+
|**语法**|**grpc_ssl_trusted_certificate** `file`;|
388+
|**默认**|——|
389+
|**上下文**|http、server、location|
390+
391+
指定一个带有 PEM 格式的可信 CA 证书的文件,用于[验证](#grpc_ssl_verify) gRPC SSL 服务器的证书。
392+
393+
### grpc_ssl_verify
394+
395+
|\-|说明|
396+
|------:|------|
397+
|**语法**|**grpc_ssl_verify** `on` | `off`;|
398+
|**默认**|grpc_ssl_verify off;|
399+
|**上下文**|http、server、location|
400+
401+
启用或禁用验证 gRPC SSL 服务器证书。
402+
403+
### grpc_ssl_verify_depth
404+
405+
|\-|说明|
406+
|------:|------|
407+
|**语法**|**grpc_ssl_verify_depth** `number`;|
408+
|**默认**|grpc_ssl_verify_depth 1;|
409+
|**上下文**|http、server、location|
410+
411+
设置 gRPC SSL 服务器证书链中的验证深度。
252412

253413
## 原文档
254414

0 commit comments

Comments
 (0)