diff --git a/README.md b/README.md index d7ea3bd..6483a51 100644 --- 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: + + + + + + + + + + + + +
PropertyDescriptionValue
redis.hostsRedis server running instance IP address and port numberdefault: 127.0.0.1:6379
ex: 127.0.0.1:6379, 127.0.0.2:6379, 127.0.0.2:6380, ....
redis.passwordRedis protected password
redis.databaseRedis database selection. (Numeric value)default: 0
redis.timeoutRedis connection timeoutdefault: 2000
redis.cluster.enabledTo enable redis cluster modedefault: false
supported values: true/false
redis.sentinel.enabledTo enable redis sentinel modedefault: false
supported values: true/false
redis.sentinel.masterRedis sentinel master namedefault: mymaster
lb.sticky-session.enabledTo enable redis and standard session mode

If enabled,
  1. Must be enabled sticky session in your load balancer configuration. Else this manager may not return the updated session values
  2. Session values are stored in local jvm and redis
  3. If redis is down/not responding, requests uses jvm stored session values to process user requests. Redis comes back the values will be synced
default: false
+ +