Skip to content

Commit 677e608

Browse files
vkazmirchukclaude
andcommitted
docs: add CLICKHOUSE_TLS_MODE documentation
- Add CLICKHOUSE_TLS_MODE to README mTLS section with valid options - Update ClickHouseConfig docstring with TLS_MODE variable Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 4d1115d commit 677e608

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,12 @@ These variables enable client certificate authentication for ClickHouse servers
352352
* Default: None
353353
* Optional if `CLICKHOUSE_CLIENT_CERT` is a `.pem` file containing both the certificate and private key
354354
* Example: `/path/to/client.key`
355+
* `CLICKHOUSE_TLS_MODE`: TLS mode for client certificate authentication
356+
* Default: None (auto-detected based on `CLICKHOUSE_CLIENT_CERT`)
357+
* Valid options:
358+
* `"mutual"` - Use client certificate for authentication (default when `CLICKHOUSE_CLIENT_CERT` is set)
359+
* `"proxy"` - TLS termination at proxy, use Basic Auth with client certs for TLS only
360+
* `"strict"` - Strict TLS mode with Basic Auth
355361

356362
#### chDB Variables
357363

mcp_clickhouse/mcp_env.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ class ClickHouseConfig:
4848
CLICKHOUSE_CA_CERT: Path to CA certificate file for SSL verification (default: None)
4949
CLICKHOUSE_CLIENT_CERT: Path to client certificate file for mTLS authentication (default: None)
5050
CLICKHOUSE_CLIENT_CERT_KEY: Path to client private key file for mTLS authentication (default: None)
51+
CLICKHOUSE_TLS_MODE: TLS mode for client certificate usage - "mutual", "proxy", or "strict" (default: None)
5152
"""
5253

5354
def __init__(self):

0 commit comments

Comments
 (0)