Embedded Servlet Container
Note that CAS itself ships with a number of embedded containers that allow the platform to be self-contained as much as possible. These embedded containers are an integral part of the CAS software, are maintained and updated usually for every release and surely are meant to and can be used in production deployments. You DO NOT need to, but can if you want to, configure and deploy to an externally configured container.
Configuration
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Third Party
- Notes
server.servlet.application-display-name=application
Display name of the application.
CAS Property:
|
1 |
server.servlet.application-display-name=application |
1
server:
servlet:
application-display-name: "application"
1
java -Dserver.servlet.application-display-name="application" -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 SERVER_SERVLET_APPLICATION_DISPLAY_NAME="application"
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 --server.servlet.application-display-name="application"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.context-parameters=
Servlet context init parameters.
org.springframework.boot.autoconfigure.web.ServerProperties$Servlet.
CAS Property: server.servlet.context-parameters
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
server.servlet.context-parameters=...
1
server:
servlet:
context-parameters: "..."
1
java -Dserver.servlet.context-parameters="..." -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 SERVER_SERVLET_CONTEXT_PARAMETERS="..."
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 --server.servlet.context-parameters="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.context-path=
Context path of the application.
org.springframework.boot.autoconfigure.web.ServerProperties$Servlet.
CAS Property: server.servlet.context-path
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
server.servlet.context-path=...
1
server:
servlet:
context-path: "..."
1
java -Dserver.servlet.context-path="..." -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 SERVER_SERVLET_CONTEXT_PATH="..."
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 --server.servlet.context-path="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.encoding.charset=UTF-8
Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly.
org.springframework.boot.web.servlet.server.Encoding.
CAS Property: server.servlet.encoding.charset
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
server.servlet.encoding.charset=UTF-8
1
server:
servlet:
encoding:
charset: "UTF-8"
1
java -Dserver.servlet.encoding.charset="UTF-8" -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 SERVER_SERVLET_ENCODING_CHARSET="UTF-8"
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 --server.servlet.encoding.charset="UTF-8"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.encoding.enabled=true
Whether to enable http encoding support.
How can I configure this property?
CAS Property: server.servlet.encoding.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
server.servlet.encoding.enabled=true
1
server:
servlet:
encoding:
enabled: "true"
1
java -Dserver.servlet.encoding.enabled="true" -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 SERVER_SERVLET_ENCODING_ENABLED="true"
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 --server.servlet.encoding.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.encoding.force=
Whether to force the encoding to the configured charset on HTTP requests and responses.
org.springframework.boot.web.servlet.server.Encoding.
CAS Property: server.servlet.encoding.force
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
server.servlet.encoding.force=...
1
server:
servlet:
encoding:
force: "..."
1
java -Dserver.servlet.encoding.force="..." -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 SERVER_SERVLET_ENCODING_FORCE="..."
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 --server.servlet.encoding.force="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.encoding.force-request=
Whether to force the encoding to the configured charset on HTTP requests. Defaults to true when "force" has not been specified.
org.springframework.boot.web.servlet.server.Encoding.
CAS Property: server.servlet.encoding.force-request
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
server.servlet.encoding.force-request=...
1
server:
servlet:
encoding:
force-request: "..."
1
java -Dserver.servlet.encoding.force-request="..." -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 SERVER_SERVLET_ENCODING_FORCE_REQUEST="..."
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 --server.servlet.encoding.force-request="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.encoding.force-response=
Whether to force the encoding to the configured charset on HTTP responses.
org.springframework.boot.web.servlet.server.Encoding.
CAS Property: server.servlet.encoding.force-response
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
server.servlet.encoding.force-response=...
1
server:
servlet:
encoding:
force-response: "..."
1
java -Dserver.servlet.encoding.force-response="..." -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 SERVER_SERVLET_ENCODING_FORCE_RESPONSE="..."
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 --server.servlet.encoding.force-response="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.encoding.mapping=
Mapping of locale to charset for response encoding.
org.springframework.boot.web.servlet.server.Encoding.
CAS Property: server.servlet.encoding.mapping
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
server.servlet.encoding.mapping=...
1
server:
servlet:
encoding:
mapping: "..."
1
java -Dserver.servlet.encoding.mapping="..." -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 SERVER_SERVLET_ENCODING_MAPPING="..."
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 --server.servlet.encoding.mapping="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.jsp.class-name=org.apache.jasper.servlet.JspServlet
Class name of the servlet to use for JSPs. If registered is true and this class * is on the classpath then it will be registered.
org.springframework.boot.web.servlet.server.Jsp.
CAS Property: server.servlet.jsp.class-name
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
server.servlet.jsp.class-name=org.apache.jasper.servlet.JspServlet
1
server:
servlet:
jsp:
class-name: "org.apache.jasper.servlet.JspServlet"
1
java -Dserver.servlet.jsp.class-name="org.apache.jasper.servlet.JspServlet" -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 SERVER_SERVLET_JSP_CLASS_NAME="org.apache.jasper.servlet.JspServlet"
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 --server.servlet.jsp.class-name="org.apache.jasper.servlet.JspServlet"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.jsp.init-parameters=
Init parameters used to configure the JSP servlet.
org.springframework.boot.web.servlet.server.Jsp.
CAS Property: server.servlet.jsp.init-parameters
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
server.servlet.jsp.init-parameters=...
1
server:
servlet:
jsp:
init-parameters: "..."
1
java -Dserver.servlet.jsp.init-parameters="..." -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 SERVER_SERVLET_JSP_INIT_PARAMETERS="..."
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 --server.servlet.jsp.init-parameters="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.jsp.registered=true
Whether the JSP servlet is registered.
org.springframework.boot.web.servlet.server.Jsp.
CAS Property: server.servlet.jsp.registered
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
server.servlet.jsp.registered=true
1
server:
servlet:
jsp:
registered: "true"
1
java -Dserver.servlet.jsp.registered="true" -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 SERVER_SERVLET_JSP_REGISTERED="true"
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 --server.servlet.jsp.registered="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.path=/
Path of the main dispatcher servlet.
How can I configure this property?
CAS Property: server.servlet.path
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
server.servlet.path=/
1
server:
servlet:
path: "/"
1
java -Dserver.servlet.path="/" -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 SERVER_SERVLET_PATH="/"
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 --server.servlet.path="/"
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.mvc.servlet.path
.
server.servlet.register-default-servlet=false
Whether to register the default Servlet with the container.
org.springframework.boot.autoconfigure.web.ServerProperties$Servlet.
CAS Property: server.servlet.register-default-servlet
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
server.servlet.register-default-servlet=...
1
server:
servlet:
register-default-servlet: "..."
1
java -Dserver.servlet.register-default-servlet="..." -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 SERVER_SERVLET_REGISTER_DEFAULT_SERVLET="..."
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 --server.servlet.register-default-servlet="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.cookie.comment=
Comment for the cookie.
How can I configure this property?
CAS Property: server.servlet.session.cookie.comment
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
server.servlet.session.cookie.comment=...
1
server:
servlet:
session:
cookie:
comment: "..."
1
java -Dserver.servlet.session.cookie.comment="..." -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 SERVER_SERVLET_SESSION_COOKIE_COMMENT="..."
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 --server.servlet.session.cookie.comment="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is ERROR
without a replacement setting.
server.servlet.session.cookie.domain=
Domain for the cookie.
org.springframework.boot.web.servlet.server.Session$Cookie.
CAS Property: server.servlet.session.cookie.domain
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
server.servlet.session.cookie.domain=...
1
server:
servlet:
session:
cookie:
domain: "..."
1
java -Dserver.servlet.session.cookie.domain="..." -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 SERVER_SERVLET_SESSION_COOKIE_DOMAIN="..."
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 --server.servlet.session.cookie.domain="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.cookie.http-only=
Whether to use "HttpOnly" cookies for the cookie.
org.springframework.boot.web.servlet.server.Session$Cookie.
CAS Property: server.servlet.session.cookie.http-only
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
server.servlet.session.cookie.http-only=...
1
server:
servlet:
session:
cookie:
http-only: "..."
1
java -Dserver.servlet.session.cookie.http-only="..." -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 SERVER_SERVLET_SESSION_COOKIE_HTTP_ONLY="..."
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 --server.servlet.session.cookie.http-only="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.cookie.max-age=
Maximum age of the cookie. If a duration suffix is not specified, seconds will be used. A positive value indicates when the cookie expires relative to the current time. A value of 0 means the cookie should expire immediately. A negative value means no "Max-Age".
org.springframework.boot.web.servlet.server.Session$Cookie.
CAS Property: server.servlet.session.cookie.max-age
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
server.servlet.session.cookie.max-age=...
1
server:
servlet:
session:
cookie:
max-age: "..."
1
java -Dserver.servlet.session.cookie.max-age="..." -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 SERVER_SERVLET_SESSION_COOKIE_MAX_AGE="..."
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 --server.servlet.session.cookie.max-age="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.cookie.name=
Name of the cookie.
org.springframework.boot.web.servlet.server.Session$Cookie.
CAS Property: server.servlet.session.cookie.name
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
server.servlet.session.cookie.name=...
1
server:
servlet:
session:
cookie:
name: "..."
1
java -Dserver.servlet.session.cookie.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 SERVER_SERVLET_SESSION_COOKIE_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 --server.servlet.session.cookie.name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.cookie.path=
Path of the cookie.
org.springframework.boot.web.servlet.server.Session$Cookie.
CAS Property: server.servlet.session.cookie.path
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
server.servlet.session.cookie.path=...
1
server:
servlet:
session:
cookie:
path: "..."
1
java -Dserver.servlet.session.cookie.path="..." -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 SERVER_SERVLET_SESSION_COOKIE_PATH="..."
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 --server.servlet.session.cookie.path="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.cookie.same-site=
SameSite setting for the cookie.
org.springframework.boot.web.servlet.server.Session$Cookie.
CAS Property: server.servlet.session.cookie.same-site
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
server.servlet.session.cookie.same-site=...
1
server:
servlet:
session:
cookie:
same-site: "..."
1
java -Dserver.servlet.session.cookie.same-site="..." -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 SERVER_SERVLET_SESSION_COOKIE_SAME_SITE="..."
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 --server.servlet.session.cookie.same-site="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.cookie.secure=
Whether to always mark the cookie as secure.
org.springframework.boot.web.servlet.server.Session$Cookie.
CAS Property: server.servlet.session.cookie.secure
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
server.servlet.session.cookie.secure=...
1
server:
servlet:
session:
cookie:
secure: "..."
1
java -Dserver.servlet.session.cookie.secure="..." -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 SERVER_SERVLET_SESSION_COOKIE_SECURE="..."
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 --server.servlet.session.cookie.secure="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.persistent=false
Whether to persist session data between restarts.
org.springframework.boot.web.servlet.server.Session.
CAS Property: server.servlet.session.persistent
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
server.servlet.session.persistent=...
1
server:
servlet:
session:
persistent: "..."
1
java -Dserver.servlet.session.persistent="..." -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 SERVER_SERVLET_SESSION_PERSISTENT="..."
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 --server.servlet.session.persistent="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.store-dir=
Directory used to store session data.
org.springframework.boot.web.servlet.server.Session.
CAS Property: server.servlet.session.store-dir
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
server.servlet.session.store-dir=...
1
server:
servlet:
session:
store-dir: "..."
1
java -Dserver.servlet.session.store-dir="..." -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 SERVER_SERVLET_SESSION_STORE_DIR="..."
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 --server.servlet.session.store-dir="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.timeout=30m
Session timeout. If a duration suffix is not specified, seconds will be used.
org.springframework.boot.web.servlet.server.Session.
CAS Property: server.servlet.session.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
server.servlet.session.timeout=30m
1
server:
servlet:
session:
timeout: "30m"
1
java -Dserver.servlet.session.timeout="30m" -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 SERVER_SERVLET_SESSION_TIMEOUT="30m"
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 --server.servlet.session.timeout="30m"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.servlet.session.tracking-modes=
Session tracking modes.
org.springframework.boot.web.servlet.server.Session.
CAS Property: server.servlet.session.tracking-modes
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
server.servlet.session.tracking-modes=...
1
server:
servlet:
session:
tracking-modes: "..."
1
java -Dserver.servlet.session.tracking-modes="..." -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 SERVER_SERVLET_SESSION_TRACKING_MODES="..."
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 --server.servlet.session.tracking-modes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.bundle=
The name of a configured SSL bundle.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.bundle
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
server.ssl.bundle=...
1
server:
ssl:
bundle: "..."
1
java -Dserver.ssl.bundle="..." -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 SERVER_SSL_BUNDLE="..."
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 --server.ssl.bundle="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.certificate=
Path to a PEM-encoded SSL certificate file.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.certificate
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
server.ssl.certificate=...
1
server:
ssl:
certificate: "..."
1
java -Dserver.ssl.certificate="..." -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 SERVER_SSL_CERTIFICATE="..."
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 --server.ssl.certificate="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.certificate-private-key=
Path to a PEM-encoded private key file for the SSL certificate.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.certificate-private-key
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
server.ssl.certificate-private-key=...
1
server:
ssl:
certificate-private-key: "..."
1
java -Dserver.ssl.certificate-private-key="..." -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 SERVER_SSL_CERTIFICATE_PRIVATE_KEY="..."
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 --server.ssl.certificate-private-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.ciphers=
Supported SSL ciphers.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.ciphers
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
server.ssl.ciphers=...
1
server:
ssl:
ciphers: "..."
1
java -Dserver.ssl.ciphers="..." -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 SERVER_SSL_CIPHERS="..."
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 --server.ssl.ciphers="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.client-auth=
Client authentication mode. Requires a trust store.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.client-auth
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
server.ssl.client-auth=...
1
server:
ssl:
client-auth: "..."
1
java -Dserver.ssl.client-auth="..." -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 SERVER_SSL_CLIENT_AUTH="..."
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 --server.ssl.client-auth="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.enabled=true
Whether to enable SSL support.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.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
server.ssl.enabled=true
1
server:
ssl:
enabled: "true"
1
java -Dserver.ssl.enabled="true" -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 SERVER_SSL_ENABLED="true"
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 --server.ssl.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.enabled-protocols=
Enabled SSL protocols.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.enabled-protocols
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
server.ssl.enabled-protocols=...
1
server:
ssl:
enabled-protocols: "..."
1
java -Dserver.ssl.enabled-protocols="..." -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 SERVER_SSL_ENABLED_PROTOCOLS="..."
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 --server.ssl.enabled-protocols="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.key-alias=
Alias that identifies the key in the key store.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.key-alias
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
server.ssl.key-alias=...
1
server:
ssl:
key-alias: "..."
1
java -Dserver.ssl.key-alias="..." -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 SERVER_SSL_KEY_ALIAS="..."
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 --server.ssl.key-alias="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.key-password=
Password used to access the key in the key store.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.key-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
server.ssl.key-password=...
1
server:
ssl:
key-password: "..."
1
java -Dserver.ssl.key-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 SERVER_SSL_KEY_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 --server.ssl.key-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.key-store=
Path to the key store that holds the SSL certificate (typically a jks file).
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.key-store
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
server.ssl.key-store=...
1
server:
ssl:
key-store: "..."
1
java -Dserver.ssl.key-store="..." -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 SERVER_SSL_KEY_STORE="..."
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 --server.ssl.key-store="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.key-store-password=
Password used to access the key store.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.key-store-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
server.ssl.key-store-password=...
1
server:
ssl:
key-store-password: "..."
1
java -Dserver.ssl.key-store-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 SERVER_SSL_KEY_STORE_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 --server.ssl.key-store-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.key-store-provider=
Provider for the key store.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.key-store-provider
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
server.ssl.key-store-provider=...
1
server:
ssl:
key-store-provider: "..."
1
java -Dserver.ssl.key-store-provider="..." -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 SERVER_SSL_KEY_STORE_PROVIDER="..."
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 --server.ssl.key-store-provider="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.key-store-type=
Type of the key store.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.key-store-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
server.ssl.key-store-type=...
1
server:
ssl:
key-store-type: "..."
1
java -Dserver.ssl.key-store-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 SERVER_SSL_KEY_STORE_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 --server.ssl.key-store-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.protocol=TLS
SSL protocol to use.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.protocol
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
server.ssl.protocol=TLS
1
server:
ssl:
protocol: "TLS"
1
java -Dserver.ssl.protocol="TLS" -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 SERVER_SSL_PROTOCOL="TLS"
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 --server.ssl.protocol="TLS"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.trust-certificate=
Path to a PEM-encoded SSL certificate authority file.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.trust-certificate
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
server.ssl.trust-certificate=...
1
server:
ssl:
trust-certificate: "..."
1
java -Dserver.ssl.trust-certificate="..." -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 SERVER_SSL_TRUST_CERTIFICATE="..."
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 --server.ssl.trust-certificate="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.trust-certificate-private-key=
Path to a PEM-encoded private key file for the SSL certificate authority.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.trust-certificate-private-key
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
server.ssl.trust-certificate-private-key=...
1
server:
ssl:
trust-certificate-private-key: "..."
1
java -Dserver.ssl.trust-certificate-private-key="..." -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 SERVER_SSL_TRUST_CERTIFICATE_PRIVATE_KEY="..."
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 --server.ssl.trust-certificate-private-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.trust-store=
Trust store that holds SSL certificates.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.trust-store
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
server.ssl.trust-store=...
1
server:
ssl:
trust-store: "..."
1
java -Dserver.ssl.trust-store="..." -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 SERVER_SSL_TRUST_STORE="..."
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 --server.ssl.trust-store="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.trust-store-password=
Password used to access the trust store.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.trust-store-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
server.ssl.trust-store-password=...
1
server:
ssl:
trust-store-password: "..."
1
java -Dserver.ssl.trust-store-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 SERVER_SSL_TRUST_STORE_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 --server.ssl.trust-store-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.trust-store-provider=
Provider for the trust store.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.trust-store-provider
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
server.ssl.trust-store-provider=...
1
server:
ssl:
trust-store-provider: "..."
1
java -Dserver.ssl.trust-store-provider="..." -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 SERVER_SSL_TRUST_STORE_PROVIDER="..."
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 --server.ssl.trust-store-provider="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.ssl.trust-store-type=
Type of the trust store.
org.springframework.boot.web.server.Ssl.
CAS Property: server.ssl.trust-store-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
server.ssl.trust-store-type=...
1
server:
ssl:
trust-store-type: "..."
1
java -Dserver.ssl.trust-store-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 SERVER_SSL_TRUST_STORE_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 --server.ssl.trust-store-type="..."
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, specially 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.
Execution
The CAS web application, once built, may be deployed in place with the embedded container via the following command:
1
java -jar /path/to/cas.war
Additionally, it is also possible to run CAS as a fully executable web application:
1
2
# chmod +x /path/to/cas.war
/path/to/cas.war
This is achieved via the build process of the deployment overlay where a launch script is inserted at the beginning of the web application artifact. If you wish to see and examine the script, run the following commands:
1
2
# X is the number of lines from the beginning of the file
head -n X /path/to.cas.war
Note that running CAS as a standalone and fully executable web application is supported on most Linux and OS X distributions. Other platforms such as Windows may require custom configuration.
The following embedded servlet containers are available:
Option | Reference |
---|---|
Apache Tomcat | Please see this guide. |
Jetty | Please see this guide. |
Undertow | Please see this guide. |