Fix environment variable naming inconsistencies in documentation #55
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #55 +/- ##
=======================================
Coverage ? 88.03%
=======================================
Files ? 17
Lines ? 660
Branches ? 0
=======================================
Hits ? 581
Misses ? 79
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Hey, thanks for the contribution! Could you also address the ones in the |
|
Thanks for the contribution, @taylorleese ! Can you please cherry-pick commit 20882ce from main into this branch? It disables the UV cache to prevent CI pipeline stalls on Windows. Once pushed, the workflow will rerun with the fix. |
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.
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.
taylorleese
force-pushed
the
fix/env-var-docs
branch
from
d0945d6 to
71ced36
Compare
|
@vchomakov I rebased to keep the PR cleaner, rather than cherry pick. |
|
Thank you, @taylorleese, for addressing the comments and contributing to MCP Redis! |
4 participants
Summary
This PR fixes inconsistencies in the environment variable naming between the documentation and the actual code implementation.
Problem
The README.md and .env.example files had incorrect names for SSL-related environment variables. The documentation was using shortened names while the actual code in
src/common/config.pyuses the full names withSSL_prefix.Changes
Updated the following environment variable names to match the actual implementation:
REDIS_CA_PATH→REDIS_SSL_CA_PATHREDIS_CERT_REQS→REDIS_SSL_CERT_REQSREDIS_CA_CERTS→REDIS_SSL_CA_CERTSFiles Modified
README.md: Updated environment variable table and example configuration.env.example: Updated environment variable names to match actual usageThis ensures users following the documentation will use the correct environment variable names that the server actually reads.