@@ -130,30 +130,44 @@ A vector store table has the following columns:
130
130
131
131
All configuration is via environment variables (typically set in a ` .env ` file):
132
132
133
- | Variable | Description | Required | Default |
134
- | ------------------------| --------------------------------------------------------| ----------| --------------|
135
- | ` DB_HOST ` | MariaDB host address | Yes | ` localhost ` |
136
- | ` DB_PORT ` | MariaDB port | No | ` 3306 ` |
137
- | ` DB_USER ` | MariaDB username | Yes | |
138
- | ` DB_PASSWORD ` | MariaDB password | Yes | |
139
- | ` DB_NAME ` | Default database (optional; can be set per query) | No | |
140
- | ` MCP_READ_ONLY ` | Enforce read-only SQL mode (` true ` /` false ` ) | No | ` true ` |
141
- | ` MCP_MAX_POOL_SIZE ` | Max DB connection pool size | No | ` 10 ` |
142
- | ` EMBEDDING_PROVIDER ` | Embedding provider (` openai ` /` gemini ` /` huggingface ` ) | No | ` None ` (Disabled)|
143
- | ` OPENAI_API_KEY ` | API key for OpenAI embeddings | Yes (if EMBEDDING_PROVIDER=openai) | |
144
- | ` GEMINI_API_KEY ` | API key for Gemini embeddings | Yes (if EMBEDDING_PROVIDER=gemini) | |
145
- | ` HF_MODEL ` | Open models from Huggingface | Yes (if EMBEDDING_PROVIDER=huggingface) | |
133
+ | Variable | Description | Required | Default |
134
+ | ------------------------ | ---------------------------------------------------- | --------------------------------------- | ---------------- |
135
+ | ` DB_HOST ` | MariaDB host address | Yes | ` localhost ` |
136
+ | ` DB_PORT ` | MariaDB port | No | ` 3306 ` |
137
+ | ` DB_USER ` | MariaDB username | Yes | |
138
+ | ` DB_PASSWORD ` | MariaDB password | Yes | |
139
+ | ` DB_NAME ` | Default database (optional; can be set per query) | No | |
140
+ | ` DB_SSL ` | Enable SSL/TLS connections (` true ` /` false ` ) | No | ` false ` |
141
+ | ` DB_SSL_CA ` | Path to SSL certificate authority file | No | |
142
+ | ` DB_SSL_CERT ` | Path to SSL client certificate file | No | |
143
+ | ` DB_SSL_KEY ` | Path to SSL client private key file | No | |
144
+ | ` DB_SSL_VERIFY_CERT ` | Verify SSL certificate (` true ` /` false ` ) | No | ` true ` |
145
+ | ` DB_SSL_VERIFY_IDENTITY ` | Verify SSL server identity (` true ` /` false ` ) | No | ` false ` |
146
+ | ` MCP_READ_ONLY ` | Enforce read-only SQL mode (` true ` /` false ` ) | No | ` true ` |
147
+ | ` MCP_MAX_POOL_SIZE ` | Max DB connection pool size | No | ` 10 ` |
148
+ | ` EMBEDDING_PROVIDER ` | Embedding provider (` openai ` /` gemini ` /` huggingface ` ) | No | ` None ` (Disabled) |
149
+ | ` OPENAI_API_KEY ` | API key for OpenAI embeddings | Yes (if EMBEDDING_PROVIDER=openai) | |
150
+ | ` GEMINI_API_KEY ` | API key for Gemini embeddings | Yes (if EMBEDDING_PROVIDER=gemini) | |
151
+ | ` HF_MODEL ` | Open models from Huggingface | Yes (if EMBEDDING_PROVIDER=huggingface) | |
146
152
147
153
#### Example ` .env ` file
148
154
149
- ** With Embedding Support (OpenAI):**
155
+ ** With Embedding Support (OpenAI) and SSL :**
150
156
``` dotenv
151
157
DB_HOST=localhost
152
158
DB_USER=your_db_user
153
159
DB_PASSWORD=your_db_password
154
160
DB_PORT=3306
155
161
DB_NAME=your_default_database
156
162
163
+ # SSL Configuration
164
+ DB_SSL=true
165
+ DB_SSL_CA=/path/to/ca-cert.pem
166
+ DB_SSL_CERT=/path/to/client-cert.pem
167
+ DB_SSL_KEY=/path/to/client-key.pem
168
+ DB_SSL_VERIFY_CERT=true
169
+ DB_SSL_VERIFY_IDENTITY=false
170
+
157
171
MCP_READ_ONLY=true
158
172
MCP_MAX_POOL_SIZE=10
159
173
@@ -174,6 +188,14 @@ MCP_READ_ONLY=true
174
188
MCP_MAX_POOL_SIZE=10
175
189
```
176
190
191
+ ** SSL Configuration Notes:**
192
+
193
+ - Set ` DB_SSL=true ` to enable SSL/TLS connections
194
+ - Certificate paths should be absolute paths to the certificate files
195
+ - Three levels of SSL verification:
196
+ 1 . ** Basic SSL** (` DB_SSL=true ` , no certificates): Encrypts connection without certificate verification
197
+ 2 . ** Certificate verification** (` DB_SSL_VERIFY_CERT=true ` ): Verifies server certificate against CA
198
+ 3 . ** Full verification** (` DB_SSL_VERIFY_CERT=true ` , ` DB_SSL_VERIFY_IDENTITY=true ` ): Verifies certificate and server identity
177
199
---
178
200
179
201
## Installation & Setup
0 commit comments