Undertow - Embedded Servlet Container Configuration
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-webapp-undertow</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-webapp-undertow:${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-webapp-undertow"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
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)
Including this module in the CAS WAR overlay is optional and unnecessary. This module is automatically included
and bundled with the CAS server distribution and there are alternative options baked in to allow one to replace
this module with another. The entry below is listed for reference only.
*/
implementation "org.apereo.cas:cas-server-webapp-undertow"
}
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
server.undertow.accesslog.dir=
Undertow access log directory.
CAS Property:
|
1 |
server.undertow.accesslog.dir=... |
1
server:
undertow:
accesslog:
dir: "..."
1
java -Dserver.undertow.accesslog.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_UNDERTOW_ACCESSLOG_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.undertow.accesslog.dir="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.accesslog.enabled=false
Whether to enable the access log.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.
CAS Property: server.undertow.accesslog.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.undertow.accesslog.enabled=...
1
server:
undertow:
accesslog:
enabled: "..."
1
java -Dserver.undertow.accesslog.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 SERVER_UNDERTOW_ACCESSLOG_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 --server.undertow.accesslog.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.accesslog.pattern=common
Format pattern for access logs.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.
CAS Property: server.undertow.accesslog.pattern
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.undertow.accesslog.pattern=common
1
server:
undertow:
accesslog:
pattern: "common"
1
java -Dserver.undertow.accesslog.pattern="common" -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_UNDERTOW_ACCESSLOG_PATTERN="common"
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.undertow.accesslog.pattern="common"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.accesslog.prefix=access_log.
Log file name prefix.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.
CAS Property: server.undertow.accesslog.prefix
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.undertow.accesslog.prefix=access_log.
1
server:
undertow:
accesslog:
prefix: "access_log."
1
java -Dserver.undertow.accesslog.prefix="access_log." -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_UNDERTOW_ACCESSLOG_PREFIX="access_log."
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.undertow.accesslog.prefix="access_log."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.accesslog.rotate=true
Whether to enable access log rotation.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.
CAS Property: server.undertow.accesslog.rotate
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.undertow.accesslog.rotate=true
1
server:
undertow:
accesslog:
rotate: "true"
1
java -Dserver.undertow.accesslog.rotate="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_UNDERTOW_ACCESSLOG_ROTATE="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.undertow.accesslog.rotate="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.accesslog.suffix=log
Log file name suffix.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Accesslog.
CAS Property: server.undertow.accesslog.suffix
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.undertow.accesslog.suffix=log
1
server:
undertow:
accesslog:
suffix: "log"
1
java -Dserver.undertow.accesslog.suffix="log" -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_UNDERTOW_ACCESSLOG_SUFFIX="log"
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.undertow.accesslog.suffix="log"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.allow-encoded-slash=false
Whether the server should decode percent encoded slash characters. Enabling encoded slashes can have security implications due to different servers interpreting the slash differently. Only enable this if you have a legacy application that requires it. Has no effect when server.undertow.decode-slash is set.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.allow-encoded-slash
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.undertow.allow-encoded-slash=...
1
server:
undertow:
allow-encoded-slash: "..."
1
java -Dserver.undertow.allow-encoded-slash="..." -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_UNDERTOW_ALLOW_ENCODED_SLASH="..."
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.undertow.allow-encoded-slash="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Deprecation status is WARNING
with a replacement setting: server.undertow.decode-slash
.
server.undertow.always-set-keep-alive=true
Whether the 'Connection: keep-alive' header should be added to all responses, even if not required by the HTTP specification.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.always-set-keep-alive
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.undertow.always-set-keep-alive=true
1
server:
undertow:
always-set-keep-alive: "true"
1
java -Dserver.undertow.always-set-keep-alive="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_UNDERTOW_ALWAYS_SET_KEEP_ALIVE="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.undertow.always-set-keep-alive="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.buffer-size=
Size of each buffer. The default is derived from the maximum amount of memory that is available to the JVM.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.buffer-size
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.undertow.buffer-size=...
1
server:
undertow:
buffer-size: "..."
1
java -Dserver.undertow.buffer-size="..." -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_UNDERTOW_BUFFER_SIZE="..."
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.undertow.buffer-size="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.buffers-per-region=
Number of buffer per region.
How can I configure this property?
CAS Property: server.undertow.buffers-per-region
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.undertow.buffers-per-region=...
1
server:
undertow:
buffers-per-region: "..."
1
java -Dserver.undertow.buffers-per-region="..." -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_UNDERTOW_BUFFERS_PER_REGION="..."
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.undertow.buffers-per-region="..."
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.undertow.decode-slash=
Whether encoded slash characters (%2F) should be decoded. Decoding can cause security problems if a front-end proxy does not perform the same decoding. Only enable this if you have a legacy application that requires it. When set, server.undertow.allow-encoded-slash has no effect.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.decode-slash
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.undertow.decode-slash=...
1
server:
undertow:
decode-slash: "..."
1
java -Dserver.undertow.decode-slash="..." -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_UNDERTOW_DECODE_SLASH="..."
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.undertow.decode-slash="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.decode-url=true
Whether the URL should be decoded. When disabled, percent-encoded characters in the URL will be left as-is.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.decode-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
server.undertow.decode-url=true
1
server:
undertow:
decode-url: "true"
1
java -Dserver.undertow.decode-url="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_UNDERTOW_DECODE_URL="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.undertow.decode-url="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.direct-buffers=
Whether to allocate buffers outside the Java heap. The default is derived from the maximum amount of memory that is available to the JVM.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.direct-buffers
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.undertow.direct-buffers=...
1
server:
undertow:
direct-buffers: "..."
1
java -Dserver.undertow.direct-buffers="..." -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_UNDERTOW_DIRECT_BUFFERS="..."
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.undertow.direct-buffers="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.eager-filter-init=true
Whether servlet filters should be initialized on startup.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.eager-filter-init
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.undertow.eager-filter-init=true
1
server:
undertow:
eager-filter-init: "true"
1
java -Dserver.undertow.eager-filter-init="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_UNDERTOW_EAGER_FILTER_INIT="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.undertow.eager-filter-init="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.max-cookies=200
Maximum number of cookies that are allowed. This limit exists to prevent hash collision based DOS attacks.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.max-cookies
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.undertow.max-cookies=200
1
server:
undertow:
max-cookies: "200"
1
java -Dserver.undertow.max-cookies="200" -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_UNDERTOW_MAX_COOKIES="200"
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.undertow.max-cookies="200"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.max-headers=
Maximum number of headers that are allowed. This limit exists to prevent hash collision based DOS attacks.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.max-headers
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.undertow.max-headers=...
1
server:
undertow:
max-headers: "..."
1
java -Dserver.undertow.max-headers="..." -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_UNDERTOW_MAX_HEADERS="..."
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.undertow.max-headers="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.max-http-post-size=-1B
Maximum size of the HTTP post content. When the value is -1, the default, the size is unlimited.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.max-http-post-size
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.undertow.max-http-post-size=-1B
1
server:
undertow:
max-http-post-size: "-1B"
1
java -Dserver.undertow.max-http-post-size="-1B" -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_UNDERTOW_MAX_HTTP_POST_SIZE="-1B"
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.undertow.max-http-post-size="-1B"
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.max-parameters=
Maximum number of query or path parameters that are allowed. This limit exists to prevent hash collision based DOS attacks.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.max-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.undertow.max-parameters=...
1
server:
undertow:
max-parameters: "..."
1
java -Dserver.undertow.max-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_UNDERTOW_MAX_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.undertow.max-parameters="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.no-request-timeout=
Amount of time a connection can sit idle without processing a request, before it is closed by the server.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.no-request-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.undertow.no-request-timeout=...
1
server:
undertow:
no-request-timeout: "..."
1
java -Dserver.undertow.no-request-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 SERVER_UNDERTOW_NO_REQUEST_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 --server.undertow.no-request-timeout="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.options.server=
Server options as defined in io.undertow.UndertowOptions.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Options.
CAS Property: server.undertow.options.server
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.undertow.options.server=...
1
server:
undertow:
options:
server: "..."
1
java -Dserver.undertow.options.server="..." -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_UNDERTOW_OPTIONS_SERVER="..."
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.undertow.options.server="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.options.socket=
Socket options as defined in org.xnio.Options.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Options.
CAS Property: server.undertow.options.socket
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.undertow.options.socket=...
1
server:
undertow:
options:
socket: "..."
1
java -Dserver.undertow.options.socket="..." -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_UNDERTOW_OPTIONS_SOCKET="..."
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.undertow.options.socket="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.preserve-path-on-forward=false
Whether to preserve the path of a request when it is forwarded.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.preserve-path-on-forward
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.undertow.preserve-path-on-forward=...
1
server:
undertow:
preserve-path-on-forward: "..."
1
java -Dserver.undertow.preserve-path-on-forward="..." -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_UNDERTOW_PRESERVE_PATH_ON_FORWARD="..."
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.undertow.preserve-path-on-forward="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.threads.io=
Number of I/O threads to create for the worker. The default is derived from the number of available processors.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Threads.
CAS Property: server.undertow.threads.io
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.undertow.threads.io=...
1
server:
undertow:
threads:
io: "..."
1
java -Dserver.undertow.threads.io="..." -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_UNDERTOW_THREADS_IO="..."
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.undertow.threads.io="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.threads.worker=
Number of worker threads. The default is 8 times the number of I/O threads.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow$Threads.
CAS Property: server.undertow.threads.worker
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.undertow.threads.worker=...
1
server:
undertow:
threads:
worker: "..."
1
java -Dserver.undertow.threads.worker="..." -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_UNDERTOW_THREADS_WORKER="..."
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.undertow.threads.worker="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
server.undertow.url-charset=UTF-8
Charset used to decode URLs.
org.springframework.boot.autoconfigure.web.ServerProperties$Undertow.
CAS Property: server.undertow.url-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.undertow.url-charset=UTF-8
1
server:
undertow:
url-charset: "UTF-8"
1
java -Dserver.undertow.url-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_UNDERTOW_URL_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.undertow.url-charset="UTF-8"
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.