Updated configuration properties.

6 years ago · aa52190ed1
parent b89e5df0ef
commit aa52190ed1
1 changed files with 17 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -48,3 +48,20 @@ more details.. https://github.com/ran-jit/tomcat-cluster-redis-session-manager/w
 ### Note:
  - **All your session attribute values must implement java.io.Serializable.**
  - Supports redis default, sentinel and cluster mode, based on the redis-data-cache.properties configuration.
+
+### Configuration Properties:
+<html>
+<body>
+    <table border="1px" style="width: 80%;margin-left: 10%;margin-right: 10%;line-height: 1.5;">
+        <tr><th style="width: 20%;">Property</th><th style="width: 40%;">Description</th><th style="width: 30%;">Value</th></tr>
+        <tr><td>redis.hosts</td><td>Redis server running instance IP address and port number</td><td>default: 127.0.0.1:6379<br>ex: 127.0.0.1:6379, 127.0.0.2:6379, 127.0.0.2:6380, ....</td></tr>
+        <tr><td>redis.password</td><td>Redis protected password</td><td></td></tr>
+        <tr><td>redis.database</td><td>Redis database selection. (Numeric value)</td><td>default: 0</td></tr>
+        <tr><td>redis.timeout</td><td>Redis connection timeout</td><td>default: 2000</td></tr>
+        <tr><td>redis.cluster.enabled</td><td>To enable redis cluster mode</td><td>default: false<br>supported values: true/false</td></tr>
+        <tr><td>redis.sentinel.enabled</td><td>To enable redis sentinel mode</td><td>default: false<br>supported values: true/false</td></tr>
+        <tr><td>redis.sentinel.master</td><td>Redis sentinel master name</td><td>default: mymaster</td></tr>
+        <tr><td>lb.sticky-session.enabled</td><td>To enable redis and standard session mode<br><br>If enabled,<ol><li>Must be enabled sticky session in your load balancer configuration. Else this manager may not return the updated session values</li><li>Session values are stored in local jvm and redis</li><li>If redis is down/not responding, requests uses jvm stored session values to process user requests. Redis comes back the values will be synced</li></ol></td><td>default: false</td></tr>
+    </table>
+</body>
+</html>