Skip to content

Commit 8d6c7bf

Browse files
committed
Fix environment variable naming inconsistencies in docs
The README.md and .env.example files had inconsistent naming for SSL-related environment variables. The actual code uses: - REDIS_SSL_CA_PATH (not REDIS_CA_PATH) - REDIS_SSL_CERT_REQS (not REDIS_CERT_REQS) - REDIS_SSL_CA_CERTS (not REDIS_CA_CERTS) This commit updates the documentation to match the actual variable names used in src/common/config.py.
1 parent d892956 commit 8d6c7bf

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

.env.example

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ REDIS_DB=0
44
REDIS_USERNAME=default
55
REDIS_PWD=your_password
66
REDIS_SSL=False
7-
REDIS_CA_PATH=/path/to/ca.pem
7+
REDIS_SSL_CA_PATH=/path/to/ca.pem
88
REDIS_SSL_KEYFILE=/path/to/key.pem
99
REDIS_SSL_CERTFILE=/path/to/cert.pem
10-
REDIS_CERT_REQS=required
11-
REDIS_CA_CERTS=/path/to/ca_certs.pem
10+
REDIS_SSL_CERT_REQS=required
11+
REDIS_SSL_CA_CERTS=/path/to/ca_certs.pem
1212
REDIS_CLUSTER_MODE=False

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ The following example is for Claude Desktop, but the same applies to any other M
195195
"REDIS_PORT": "<your_redis_database_port>",
196196
"REDIS_PWD": "<your_redis_database_password>",
197197
"REDIS_SSL": True|False,
198-
"REDIS_CA_PATH": "<your_redis_ca_path>",
198+
"REDIS_SSL_CA_PATH": "<your_redis_ca_path>",
199199
"REDIS_CLUSTER_MODE": True|False
200200
}
201201
}
@@ -308,11 +308,11 @@ If desired, you can use environment variables. Defaults are provided for all var
308308
| `REDIS_USERNAME` | Default database username | `"default"` |
309309
| `REDIS_PWD` | Default database password | "" |
310310
| `REDIS_SSL` | Enables or disables SSL/TLS | `False` |
311-
| `REDIS_CA_PATH` | CA certificate for verifying server | None |
311+
| `REDIS_SSL_CA_PATH` | CA certificate for verifying server | None |
312312
| `REDIS_SSL_KEYFILE` | Client's private key file for client authentication | None |
313313
| `REDIS_SSL_CERTFILE` | Client's certificate file for client authentication | None |
314-
| `REDIS_CERT_REQS` | Whether the client should verify the server's certificate | `"required"` |
315-
| `REDIS_CA_CERTS` | Path to the trusted CA certificates file | None |
314+
| `REDIS_SSL_CERT_REQS`| Whether the client should verify the server's certificate | `"required"` |
315+
| `REDIS_SSL_CA_CERTS` | Path to the trusted CA certificates file | None |
316316
| `REDIS_CLUSTER_MODE` | Enable Redis Cluster mode | `False` |
317317

318318

0 commit comments

Comments
 (0)