Merge pull request #55 from taylorleese/fix/env-var-docs

Fix environment variable naming inconsistencies in documentation

Author: vchomakov

.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

README.md

@@ -196,7 +196,7 @@ The following example is for Claude Desktop, but the same applies to any other M
                 "REDIS_PORT": "<your_redis_database_port>",
                 "REDIS_PWD": "<your_redis_database_password>",
                 "REDIS_SSL": True|False,
-                "REDIS_CA_PATH": "<your_redis_ca_path>",
+                "REDIS_SSL_CA_PATH": "<your_redis_ca_path>",
                 "REDIS_CLUSTER_MODE": True|False
             }
         }
@@ -309,11 +309,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`       |
 
 

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: ""