WORKERS AHEAD!
You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.
Server-side Sessions - Redis
If you don’t wish to use the native container’s strategy for session replication, you can use CAS’s support for Redis session replication.
This feature is enabled via the following module:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-session-redis</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-session-redis:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-session-redis"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-session-redis"
}
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Third Party
- Notes
spring.redis.client-name=
How can I configure this property?
CAS Property:
|
1 |
spring.redis.client-name=... |
1
spring:
redis:
client-name: "..."
1
java -Dspring.redis.client-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_CLIENT_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.client-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.client-name
.
spring.redis.client-type=
How can I configure this property?
CAS Property: spring.redis.client-type

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.client-type=...
1
spring:
redis:
client-type: "..."
1
java -Dspring.redis.client-type="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_CLIENT_TYPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.client-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.client-type
.
spring.redis.cluster.max-redirects=
How can I configure this property?
CAS Property: spring.redis.cluster.max-redirects

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.cluster.max-redirects=...
1
spring:
redis:
cluster:
max-redirects: "..."
1
java -Dspring.redis.cluster.max-redirects="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_CLUSTER_MAX_REDIRECTS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.cluster.max-redirects="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.cluster.max-redirects
.
spring.redis.cluster.nodes=
How can I configure this property?
CAS Property: spring.redis.cluster.nodes

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.cluster.nodes=...
1
spring:
redis:
cluster:
nodes: "..."
1
java -Dspring.redis.cluster.nodes="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_CLUSTER_NODES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.cluster.nodes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.cluster.nodes
.
spring.redis.connect-timeout=
How can I configure this property?
CAS Property: spring.redis.connect-timeout

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.connect-timeout=...
1
spring:
redis:
connect-timeout: "..."
1
java -Dspring.redis.connect-timeout="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_CONNECT_TIMEOUT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.connect-timeout="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.connect-timeout
.
spring.redis.database=
How can I configure this property?
CAS Property: spring.redis.database

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.database=...
1
spring:
redis:
database: "..."
1
java -Dspring.redis.database="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_DATABASE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.database="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.database
.
spring.redis.host=
How can I configure this property?
CAS Property: spring.redis.host

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.host=...
1
spring:
redis:
host: "..."
1
java -Dspring.redis.host="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_HOST="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.host="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.host
.
spring.redis.jedis.pool.enabled=
How can I configure this property?
CAS Property: spring.redis.jedis.pool.enabled

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.jedis.pool.enabled=...
1
spring:
redis:
jedis:
pool:
enabled: "..."
1
java -Dspring.redis.jedis.pool.enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_JEDIS_POOL_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.jedis.pool.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.jedis.pool.max-active=
How can I configure this property?
CAS Property: spring.redis.jedis.pool.max-active

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.jedis.pool.max-active=...
1
spring:
redis:
jedis:
pool:
max-active: "..."
1
java -Dspring.redis.jedis.pool.max-active="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_JEDIS_POOL_MAX_ACTIVE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.jedis.pool.max-active="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.jedis.pool.max-idle=
How can I configure this property?
CAS Property: spring.redis.jedis.pool.max-idle

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.jedis.pool.max-idle=...
1
spring:
redis:
jedis:
pool:
max-idle: "..."
1
java -Dspring.redis.jedis.pool.max-idle="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_JEDIS_POOL_MAX_IDLE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.jedis.pool.max-idle="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.jedis.pool.max-wait=
How can I configure this property?
CAS Property: spring.redis.jedis.pool.max-wait

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.jedis.pool.max-wait=...
1
spring:
redis:
jedis:
pool:
max-wait: "..."
1
java -Dspring.redis.jedis.pool.max-wait="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_JEDIS_POOL_MAX_WAIT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.jedis.pool.max-wait="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.jedis.pool.min-idle=
How can I configure this property?
CAS Property: spring.redis.jedis.pool.min-idle

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.jedis.pool.min-idle=...
1
spring:
redis:
jedis:
pool:
min-idle: "..."
1
java -Dspring.redis.jedis.pool.min-idle="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_JEDIS_POOL_MIN_IDLE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.jedis.pool.min-idle="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.jedis.pool.time-between-eviction-runs=
How can I configure this property?
CAS Property: spring.redis.jedis.pool.time-between-eviction-runs

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.jedis.pool.time-between-eviction-runs=...
1
spring:
redis:
jedis:
pool:
time-between-eviction-runs: "..."
1
java -Dspring.redis.jedis.pool.time-between-eviction-runs="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_JEDIS_POOL_TIME_BETWEEN_EVICTION_RUNS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.jedis.pool.time-between-eviction-runs="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.lettuce.cluster.refresh.adaptive=
How can I configure this property?
CAS Property: spring.redis.lettuce.cluster.refresh.adaptive

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.cluster.refresh.adaptive=...
1
spring:
redis:
lettuce:
cluster:
refresh:
adaptive: "..."
1
java -Dspring.redis.lettuce.cluster.refresh.adaptive="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_CLUSTER_REFRESH_ADAPTIVE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.cluster.refresh.adaptive="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.lettuce.cluster.refresh.adaptive
.
spring.redis.lettuce.cluster.refresh.dynamic-refresh-sources=
How can I configure this property?
CAS Property: spring.redis.lettuce.cluster.refresh.dynamic-refresh-sources

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.cluster.refresh.dynamic-refresh-sources=...
1
spring:
redis:
lettuce:
cluster:
refresh:
dynamic-refresh-sources: "..."
1
java -Dspring.redis.lettuce.cluster.refresh.dynamic-refresh-sources="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_CLUSTER_REFRESH_DYNAMIC_REFRESH_SOURCES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.cluster.refresh.dynamic-refresh-sources="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.lettuce.cluster.refresh.dynamic-refresh-sources
.
spring.redis.lettuce.cluster.refresh.period=
How can I configure this property?
CAS Property: spring.redis.lettuce.cluster.refresh.period

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.cluster.refresh.period=...
1
spring:
redis:
lettuce:
cluster:
refresh:
period: "..."
1
java -Dspring.redis.lettuce.cluster.refresh.period="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_CLUSTER_REFRESH_PERIOD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.cluster.refresh.period="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.lettuce.cluster.refresh.period
.
spring.redis.lettuce.pool.enabled=
How can I configure this property?
CAS Property: spring.redis.lettuce.pool.enabled

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.pool.enabled=...
1
spring:
redis:
lettuce:
pool:
enabled: "..."
1
java -Dspring.redis.lettuce.pool.enabled="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_POOL_ENABLED="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.pool.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.lettuce.pool.max-active=
How can I configure this property?
CAS Property: spring.redis.lettuce.pool.max-active

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.pool.max-active=...
1
spring:
redis:
lettuce:
pool:
max-active: "..."
1
java -Dspring.redis.lettuce.pool.max-active="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_POOL_MAX_ACTIVE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.pool.max-active="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.lettuce.pool.max-idle=
How can I configure this property?
CAS Property: spring.redis.lettuce.pool.max-idle

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.pool.max-idle=...
1
spring:
redis:
lettuce:
pool:
max-idle: "..."
1
java -Dspring.redis.lettuce.pool.max-idle="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_POOL_MAX_IDLE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.pool.max-idle="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.lettuce.pool.max-wait=
How can I configure this property?
CAS Property: spring.redis.lettuce.pool.max-wait

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.pool.max-wait=...
1
spring:
redis:
lettuce:
pool:
max-wait: "..."
1
java -Dspring.redis.lettuce.pool.max-wait="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_POOL_MAX_WAIT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.pool.max-wait="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.lettuce.pool.min-idle=
How can I configure this property?
CAS Property: spring.redis.lettuce.pool.min-idle

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.pool.min-idle=...
1
spring:
redis:
lettuce:
pool:
min-idle: "..."
1
java -Dspring.redis.lettuce.pool.min-idle="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_POOL_MIN_IDLE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.pool.min-idle="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.lettuce.pool.time-between-eviction-runs=
How can I configure this property?
CAS Property: spring.redis.lettuce.pool.time-between-eviction-runs

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.pool.time-between-eviction-runs=...
1
spring:
redis:
lettuce:
pool:
time-between-eviction-runs: "..."
1
java -Dspring.redis.lettuce.pool.time-between-eviction-runs="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_POOL_TIME_BETWEEN_EVICTION_RUNS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.pool.time-between-eviction-runs="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
spring.redis.lettuce.shutdown-timeout=
How can I configure this property?
CAS Property: spring.redis.lettuce.shutdown-timeout

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.lettuce.shutdown-timeout=...
1
spring:
redis:
lettuce:
shutdown-timeout: "..."
1
java -Dspring.redis.lettuce.shutdown-timeout="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_LETTUCE_SHUTDOWN_TIMEOUT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.lettuce.shutdown-timeout="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.lettuce.shutdown-timeout
.
spring.redis.password=
How can I configure this property?
CAS Property: spring.redis.password

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.password=...
1
spring:
redis:
password: "..."
1
java -Dspring.redis.password="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_PASSWORD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.password
.
spring.redis.port=
How can I configure this property?
CAS Property: spring.redis.port

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.port=...
1
spring:
redis:
port: "..."
1
java -Dspring.redis.port="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_PORT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.port="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.port
.
spring.redis.sentinel.master=
How can I configure this property?
CAS Property: spring.redis.sentinel.master

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.sentinel.master=...
1
spring:
redis:
sentinel:
master: "..."
1
java -Dspring.redis.sentinel.master="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_SENTINEL_MASTER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.sentinel.master="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.sentinel.master
.
spring.redis.sentinel.nodes=
How can I configure this property?
CAS Property: spring.redis.sentinel.nodes

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.sentinel.nodes=...
1
spring:
redis:
sentinel:
nodes: "..."
1
java -Dspring.redis.sentinel.nodes="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_SENTINEL_NODES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.sentinel.nodes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.sentinel.nodes
.
spring.redis.sentinel.password=
How can I configure this property?
CAS Property: spring.redis.sentinel.password

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.sentinel.password=...
1
spring:
redis:
sentinel:
password: "..."
1
java -Dspring.redis.sentinel.password="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_SENTINEL_PASSWORD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.sentinel.password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.sentinel.password
.
spring.redis.sentinel.username=
How can I configure this property?
CAS Property: spring.redis.sentinel.username

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.sentinel.username=...
1
spring:
redis:
sentinel:
username: "..."
1
java -Dspring.redis.sentinel.username="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_SENTINEL_USERNAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.sentinel.username="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.sentinel.username
.
spring.redis.ssl=
How can I configure this property?
CAS Property: spring.redis.ssl

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.ssl=...
1
spring:
redis:
ssl: "..."
1
java -Dspring.redis.ssl="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_SSL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.ssl="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.ssl
.
spring.redis.timeout=
How can I configure this property?
CAS Property: spring.redis.timeout

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.timeout=...
1
spring:
redis:
timeout: "..."
1
java -Dspring.redis.timeout="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_TIMEOUT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.timeout="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.timeout
.
spring.redis.url=
How can I configure this property?
CAS Property: spring.redis.url

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.url=...
1
spring:
redis:
url: "..."
1
java -Dspring.redis.url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.url
.
spring.redis.username=
How can I configure this property?
CAS Property: spring.redis.username

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.redis.username=...
1
spring:
redis:
username: "..."
1
java -Dspring.redis.username="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_REDIS_USERNAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.redis.username="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
with a replacement setting: spring.data.redis.username
.
spring.session.redis.cleanup-cron=0 * * * * *
Cron expression for expired session cleanup job. Only supported when repository-type is set to indexed. Not supported with a reactive session repository.
org.springframework.boot.autoconfigure.session.RedisSessionProperties.
CAS Property: spring.session.redis.cleanup-cron

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.session.redis.cleanup-cron=0 * * * * *
1
spring:
session:
redis:
cleanup-cron: "0 * * * * *"
1
java -Dspring.session.redis.cleanup-cron="0 * * * * *" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_SESSION_REDIS_CLEANUP_CRON="0 * * * * *"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.session.redis.cleanup-cron="0 * * * * *"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.session.redis.configure-action=notify-keyspace-events
The configure action to apply when no user-defined ConfigureRedisAction or ConfigureReactiveRedisAction bean is present.
org.springframework.boot.autoconfigure.session.RedisSessionProperties.
CAS Property: spring.session.redis.configure-action

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.session.redis.configure-action=notify-keyspace-events
1
spring:
session:
redis:
configure-action: "notify-keyspace-events"
1
java -Dspring.session.redis.configure-action="notify-keyspace-events" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_SESSION_REDIS_CONFIGURE_ACTION="notify-keyspace-events"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.session.redis.configure-action="notify-keyspace-events"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.session.redis.flush-mode=on-save
Sessions flush mode. Determines when session changes are written to the session store. Not supported with a reactive session repository.
org.springframework.boot.autoconfigure.session.RedisSessionProperties.
CAS Property: spring.session.redis.flush-mode

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.session.redis.flush-mode=on-save
1
spring:
session:
redis:
flush-mode: "on-save"
1
java -Dspring.session.redis.flush-mode="on-save" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_SESSION_REDIS_FLUSH_MODE="on-save"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.session.redis.flush-mode="on-save"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.session.redis.namespace=spring:session
Namespace for keys used to store sessions.
org.springframework.boot.autoconfigure.session.RedisSessionProperties.
CAS Property: spring.session.redis.namespace

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.session.redis.namespace=spring:session
1
spring:
session:
redis:
namespace: "spring:session"
1
java -Dspring.session.redis.namespace="spring:session" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_SESSION_REDIS_NAMESPACE="spring:session"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.session.redis.namespace="spring:session"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.session.redis.repository-type=default
Type of Redis session repository to configure.
org.springframework.boot.autoconfigure.session.RedisSessionProperties.
CAS Property: spring.session.redis.repository-type

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.session.redis.repository-type=default
1
spring:
session:
redis:
repository-type: "default"
1
java -Dspring.session.redis.repository-type="default" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_SESSION_REDIS_REPOSITORY_TYPE="default"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.session.redis.repository-type="default"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.session.redis.save-mode=on-set-attribute
Sessions save mode. Determines how session changes are tracked and saved to the session store.
org.springframework.boot.autoconfigure.session.RedisSessionProperties.
CAS Property: spring.session.redis.save-mode

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
spring.session.redis.save-mode=on-set-attribute
1
spring:
session:
redis:
save-mode: "on-set-attribute"
1
java -Dspring.session.redis.save-mode="on-set-attribute" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_SESSION_REDIS_SAVE_MODE="on-set-attribute"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.session.redis.save-mode="on-set-attribute"
cas.war
with an embedded server container and can be found in the build/libs
directory.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.