summaryrefslogtreecommitdiff
path: root/docs/grootstream-config.md
diff options
context:
space:
mode:
authordoufenghu <[email protected]>2024-10-18 20:28:58 +0800
committerdoufenghu <[email protected]>2024-10-18 20:28:58 +0800
commit688018ae7d6aa080fdfb2b99db52112663987651 (patch)
tree996fd4baf41e81d5addaa8c2c17b9c70ccb70725 /docs/grootstream-config.md
parentfd54e003f5e852ad6735e400d3feca024dc5e5f3 (diff)
[Improve][docs] Define ssl config skip_verification
Diffstat (limited to 'docs/grootstream-config.md')
-rw-r--r--docs/grootstream-config.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/grootstream-config.md b/docs/grootstream-config.md
index 5526037..b7fd037 100644
--- a/docs/grootstream-config.md
+++ b/docs/grootstream-config.md
@@ -103,21 +103,21 @@ Key Management System(KMS). It is a service that provides a secure way to create
## SSL
-Client enabled SSL configuration. It is used to client SSL mutual authentication with Vault.
+The client SSL configuration.
| Name | Type | Required | Default | Description |
|:-----| :----- | :------- | :-- ---- |:------------------------------------------------ |
-| enabled | Boolean | Yes | false | Enable SSL configuration. |
-| cert_file | String | Yes | (none) | The path of the certificate file. |
-| key_file | String | Yes | (none) | The path of the private key file. |
-| require_client_auth | Boolean | Yes | false | Enable client authentication |
+| skip_verification | Boolean | Yes | true | Ignore SSL certificate verification |
+| certificate_path | String | Yes | (none) | Path to the client's private key file |
+| private_key_path | String | Yes | (none) | Path to the client's certificate file |
+| ca_certificate_path | Boolean | Yes | false | Path to the root CA certificate for server verification |
```yaml
ssl:
- enabled: true
- cert_file: /path/to/cert.pem
- key_file: /path/to/key.pem
- require_client_auth: true
+ skip_verification: true
+ private_key_path: /path/to/certs/worker.key
+ certificate_path: /path/to/certs/worker.pem
+ ca_certificate_path: /path/to/certs/root.pem
```