|
3 | 3 | "id": "access-log-fields",
|
4 | 4 | "title": "Access Log Fields",
|
5 | 5 | "path": "/access-log-fields",
|
6 |
| - "description": "Use Access Log Fields to display HTTP request logs from the proxy service.", |
| 6 | + "description": "Displays HTTP request logs from the Pomerium Proxy service.", |
7 | 7 | "short_description": "",
|
8 | 8 | "type": "string",
|
9 | 9 | "services": ["proxy"]
|
|
21 | 21 | "id": "address",
|
22 | 22 | "title": "Address",
|
23 | 23 | "path": "/address",
|
24 |
| - "description": "Address specifies the host and port to serve HTTP requests from.", |
| 24 | + "description": "Specifies the Host and Port to serve HTTP requests from.", |
25 | 25 | "short_description": "Specify host and port to serve HTTP requests from",
|
26 | 26 | "type": "string",
|
27 | 27 | "services": ["proxy"]
|
|
129 | 129 | "short_description": "Certificate relative file location string",
|
130 | 130 | "services": []
|
131 | 131 | },
|
| 132 | + "certificate-authority": { |
| 133 | + "id": "certificate-authority", |
| 134 | + "title": "Certificates Authority", |
| 135 | + "path": "/certificates#certificate-authority", |
| 136 | + "type": "string", |
| 137 | + "description": "Defines a set of root certificate authorities that Pomerium uses when communicating with other TLS-protected services.", |
| 138 | + "services": [] |
| 139 | + }, |
132 | 140 | "downstream-mtls-client-certificate-authority": {
|
133 | 141 | "id": "downstream-mtls-client-certificate-authority",
|
134 | 142 | "title": "Downstream mTLS Certificate Authority",
|
|
279 | 287 | "id": "javascript-security",
|
280 | 288 | "title": "Javascript Security",
|
281 | 289 | "path": "/cookies#cookie-http-only",
|
282 |
| - "description": "If true, prevents javascript in browsers from reading user session cookies.", |
| 290 | + "description": "If applied, prevents JavaScript in browsers from reading user session cookies.", |
283 | 291 | "short_description": "Prevent JavaScript in browsers from reading user session cookies",
|
284 | 292 | "services": [],
|
285 | 293 | "type": "bool"
|
|
373 | 381 | "id": "read-timeout",
|
374 | 382 | "title": "Read Timeout",
|
375 | 383 | "path": "/global-timeouts#read-timeout",
|
376 |
| - "description": "The amount of time for the client to receive the entire request stream.", |
| 384 | + "description": "Sets the amount of time for the client to receive the entire request stream.", |
377 | 385 | "short_description": "Amount of time for client to receive entire request stream.",
|
378 | 386 | "services": [],
|
379 | 387 | "type": ""
|
|
382 | 390 | "id": "write-timeout",
|
383 | 391 | "title": "Write Timeout",
|
384 | 392 | "path": "/global-timeouts#write-timeout",
|
385 |
| - "description": "The max stream duration is the maximum time that a stream’s lifetime will span. An HTTP request/response exchange fully consumes a single stream. Therefore, this value must be greater than read_timeout as it covers both request and response time.", |
| 393 | + "description": "Sets max stream duration of an HTTP request/response exchange. Must be greater than read timeout.", |
386 | 394 | "short_description": "Sets maximum stream duration of an HTTP request/response exchange. Must be greater than read_timeout.",
|
387 | 395 | "services": [],
|
388 | 396 | "type": ""
|
|
391 | 399 | "id": "idle-timeout",
|
392 | 400 | "title": "Idle Timeout",
|
393 | 401 | "path": "/global-timeouts#idle-timeout",
|
394 |
| - "description": "Sets the time at which a downstream or upstream connection will be terminated if there are no active streams.", |
| 402 | + "description": "Sets the time at which a downstream or upstream connection will be terminated if no active streams.", |
395 | 403 | "short_description": "Sets the time to terminate a connection if there are no active streams.",
|
396 | 404 | "services": [],
|
397 | 405 | "type": ""
|
|
438 | 446 | "id": "http-redirect-address",
|
439 | 447 | "title": "HTTP Redirect Address",
|
440 | 448 | "path": "/http-redirect-address",
|
441 |
| - "description": "If set, the HTTP Redirect Address specifies the host and port to redirect http to https traffic on.", |
| 449 | + "description": "If set, HTTP Redirect Address specifies the Host and Port to redirect HTTP to HTTPS traffic on.", |
442 | 450 | "services": [],
|
443 | 451 | "type": "string"
|
444 | 452 | },
|
|
462 | 470 | "id": "log-level",
|
463 | 471 | "title": "Log Level",
|
464 | 472 | "path": "/log-level",
|
465 |
| - "description": "Log level sets the global logging level for pomerium.", |
| 473 | + "description": "Sets the global logging level for this cluster.", |
466 | 474 | "services": [],
|
467 | 475 | "type": "string"
|
468 | 476 | },
|
|
509 | 517 | "id": "proxy-log-level",
|
510 | 518 | "title": "Proxy Log Level",
|
511 | 519 | "path": "/proxy-log-level",
|
512 |
| - "description": "Log level sets the logging level for the Pomerium Proxy service.", |
| 520 | + "description": "Sets the logging level for the Pomerium Proxy service.", |
513 | 521 | "services": [],
|
514 | 522 | "type": "string"
|
515 | 523 | },
|
|
545 | 553 | "path": "/tracing",
|
546 | 554 | "services": []
|
547 | 555 | },
|
| 556 | + "tracing-provider": { |
| 557 | + "id": "tracing-provider", |
| 558 | + "title": "Tracing Provider", |
| 559 | + "description": "The name of the tracing provider. For example, Jaeger or Zipkin. Required.", |
| 560 | + "path": "/tracing", |
| 561 | + "services": [] |
| 562 | + }, |
| 563 | + "tracing-sample-rate": { |
| 564 | + "id": "tracing-sample-rate", |
| 565 | + "title": "Tracing Sample Rate", |
| 566 | + "description": "The percentage of requests to sample in decimal notation. Default is 0.0001, or .01%. Optional.", |
| 567 | + "path": "/tracing", |
| 568 | + "services": [] |
| 569 | + }, |
548 | 570 | "use-proxy-protocol": {
|
549 | 571 | "id": "use-proxy-protocol",
|
550 | 572 | "title": "Use Proxy Protocol",
|
|
658 | 680 | "id": "default-upstream-timeout",
|
659 | 681 | "title": "Default Upstream Timeout",
|
660 | 682 | "path": "/default-upstream-timeout",
|
661 |
| - "description": "Default Upstream Timeout is the default timeout applied to a proxied route when no timeout key is specified by the policy.", |
| 683 | + "description": "Sets the default timeout applied to a proxied route when no timeout key is specified by the policy.", |
662 | 684 | "services": [],
|
663 | 685 | "type": ""
|
664 | 686 | },
|
|
0 commit comments