Fix environment variable naming inconsistencies in documentation #55
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #55 +/- ##
=======================================
Coverage ? 87.23%
=======================================
Files ? 16
Lines ? 611
Branches ? 0
=======================================
Hits ? 533
Misses ? 78
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 |
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.