From 8d6c7bfcefac9cefafbc55b4e4b72240d4d06237 Mon Sep 17 00:00:00 2001 From: Taylor Leese Date: Sun, 14 Sep 2025 14:59:10 -0700 Subject: [PATCH 1/2] 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. --- .env.example | 6 +++--- README.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.env.example b/.env.example index 2c31c20..eff314f 100644 --- a/.env.example +++ b/.env.example @@ -4,9 +4,9 @@ REDIS_DB=0 REDIS_USERNAME=default REDIS_PWD=your_password REDIS_SSL=False -REDIS_CA_PATH=/path/to/ca.pem +REDIS_SSL_CA_PATH=/path/to/ca.pem REDIS_SSL_KEYFILE=/path/to/key.pem REDIS_SSL_CERTFILE=/path/to/cert.pem -REDIS_CERT_REQS=required -REDIS_CA_CERTS=/path/to/ca_certs.pem +REDIS_SSL_CERT_REQS=required +REDIS_SSL_CA_CERTS=/path/to/ca_certs.pem REDIS_CLUSTER_MODE=False \ No newline at end of file diff --git a/README.md b/README.md index e2927e1..ac548ed 100644 --- a/README.md +++ b/README.md @@ -195,7 +195,7 @@ The following example is for Claude Desktop, but the same applies to any other M "REDIS_PORT": "", "REDIS_PWD": "", "REDIS_SSL": True|False, - "REDIS_CA_PATH": "", + "REDIS_SSL_CA_PATH": "", "REDIS_CLUSTER_MODE": True|False } } @@ -308,11 +308,11 @@ If desired, you can use environment variables. Defaults are provided for all var | `REDIS_USERNAME` | Default database username | `"default"` | | `REDIS_PWD` | Default database password | "" | | `REDIS_SSL` | Enables or disables SSL/TLS | `False` | -| `REDIS_CA_PATH` | CA certificate for verifying server | None | +| `REDIS_SSL_CA_PATH` | CA certificate for verifying server | None | | `REDIS_SSL_KEYFILE` | Client's private key file for client authentication | None | | `REDIS_SSL_CERTFILE` | Client's certificate file for client authentication | None | -| `REDIS_CERT_REQS` | Whether the client should verify the server's certificate | `"required"` | -| `REDIS_CA_CERTS` | Path to the trusted CA certificates file | None | +| `REDIS_SSL_CERT_REQS`| Whether the client should verify the server's certificate | `"required"` | +| `REDIS_SSL_CA_CERTS` | Path to the trusted CA certificates file | None | | `REDIS_CLUSTER_MODE` | Enable Redis Cluster mode | `False` | From a27d0d1c0cabdcc77d4729944bfee1454169b5bd Mon Sep 17 00:00:00 2001 From: Taylor Leese Date: Mon, 15 Sep 2025 14:26:34 -0700 Subject: [PATCH 2/2] Fix SSL environment variable names in smithery.yaml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update smithery.yaml to use consistent SSL environment variable names that match the actual implementation in src/common/config.py: - redisCAPath → redisSSLCAPath (maps to REDIS_SSL_CA_PATH) - redisCertReqs → redisSSLCertReqs (maps to REDIS_SSL_CERT_REQS) - redisCACerts → redisSSLCACerts (maps to REDIS_SSL_CA_CERTS) This ensures the Smithery configuration uses the correct environment variable names that the server actually reads. --- smithery.yaml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/smithery.yaml b/smithery.yaml index 48c5bdf..7dfa227 100644 --- a/smithery.yaml +++ b/smithery.yaml @@ -27,7 +27,7 @@ startCommand: type: boolean default: false description: Enable SSL for Redis connection - redisCAPath: + redisSSLCAPath: type: string default: "" description: CA certificate path for verifying server @@ -39,11 +39,11 @@ startCommand: type: string default: "" description: Client certificate file for authentication - redisCertReqs: + redisSSLCertReqs: type: string default: required description: Certificate requirements - redisCACerts: + redisSSLCACerts: type: string default: "" description: Path to trusted CA certificates file @@ -59,11 +59,11 @@ startCommand: REDIS_USERNAME: config.redisUsername, REDIS_PWD: config.redisPwd, REDIS_SSL: String(config.redisSSL), - REDIS_CA_PATH: config.redisCAPath, + REDIS_SSL_CA_PATH: config.redisSSLCAPath, REDIS_SSL_KEYFILE: config.redisSSLKeyfile, REDIS_SSL_CERTFILE: config.redisSSLCertfile, - REDIS_CERT_REQS: config.redisCertReqs, - REDIS_CA_CERTS: config.redisCACerts + REDIS_SSL_CERT_REQS: config.redisSSLCertReqs, + REDIS_SSL_CA_CERTS: config.redisSSLCACerts } }) exampleConfig: @@ -72,8 +72,8 @@ startCommand: redisUsername: default redisPwd: "" redisSSL: false - redisCAPath: "" + redisSSLCAPath: "" redisSSLKeyfile: "" redisSSLCertfile: "" - redisCertReqs: required - redisCACerts: "" + redisSSLCertReqs: required + redisSSLCACerts: ""