Skip to content

docs: grpc tls options #1915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicecui merged 1 commit into from
Jul 7, 2025
Merged

docs: grpc tls options #1915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/user-guide/deployments-administration/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,16 +191,16 @@ The following table describes the options in detail:
| | addr | String | Server address, "127.0.0.1:4003" by default |
| | runtime_size | Integer | The number of server worker threads, 2 by default |

For MySQL and Postgres interface, TLS can be configured to enable transport
For MySQL, Postgres and gRPC interface, TLS can be configured to enable transport
layer security.

| Option | Key | Type | Description |
| ----------------------------- | ----------- | ------- | ------------------------------------------------------------- |
| `mysql.tls` or `postgres.tls` | | | TLS configuration for MySQL and Postgres |
| | `mode` | String | TLS mode, options are `disable`, `prefer` and `require` |
| | `cert_path` | String | File path for TLS certificate |
| | `key_path` | String | File path for TLS private key |
| | `watch` | Boolean | Watch file system changes and reload certificate and key file |
| Option | Key | Type | Description |
| ------------------------------------------| ----------- | ------- | ------------------------------------------------------------- |
| `mysql.tls`, `postgres.tls` or `grpc.tls` | | | TLS configuration for MySQL and Postgres |
| | `mode` | String | TLS mode, options are `disable`, `prefer` and `require` |
| | `cert_path` | String | File path for TLS certificate |
| | `key_path` | String | File path for TLS private key |
| | `watch` | Boolean | Watch file system changes and reload certificate and key file |

### Query options

Expand Down
18 changes: 9 additions & 9 deletions ...gin-content-docs/current/user-guide/deployments-administration/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,15 +179,15 @@ enable = true
| | addr | 字符串 | 服务器地址，默认为 "127.0.0.1:4003" |
| | runtime_size | 整数 | 服务器工作线程数量，默认为 2 |

对 MySQL 和 Postgres 接口，我们支持 TLS 配置

| Option | Key | Type | Description |
|-------------------------------|-------------|---------|--------------------------------------------------|
| `mysql.tls` 或 `postgres.tls` | | | MySQL 或 Postgres 的 TLS 配置 |
| | `mode` | String | TLS 模式，支持 `disable`, `prefer` and `require` |
| | `cert_path` | String | TLS 证书文件路径 |
| | `key_path` | String | TLS 私钥文件路径 |
| | `watch` | Boolean | 监控文件变化，自动重新加载证书或私钥 |
对 MySQL，Postgres 和 gRPC 接口，我们支持 TLS 配置

| Option | Key | Type | Description |
|------------------------------------------|-------------|---------|--------------------------------------------------|
| `mysql.tls`，`postgres.tls` 或 `grpc.tls` | | | MySQL 或 Postgres 的 TLS 配置 |
| | `mode` | String | TLS 模式，支持 `disable`, `prefer` and `require` |
| | `cert_path` | String | TLS 证书文件路径 |
| | `key_path` | String | TLS 私钥文件路径 |
| | `watch` | Boolean | 监控文件变化，自动重新加载证书或私钥 |

### 查询选项

Expand Down