WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

Jetty - Embedded Servlet Container Configuration

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-webapp-jetty</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-webapp-jetty:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-webapp-jetty"
}

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-jetty"
}

Embedded Jetty Container

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

cas.server.jetty.sni-host-check=true

Server Name Indication is an extension of the Transport Layer Security (TLS) protocol, which allows a client to indicate which hostname it is attempting to connect to at the start of the handshaking process. This is particularly useful when a server hosts multiple domains with different SSL certificates on a single IP address. Setting this setting to false would mean that the Jetty server will not strictly require clients to send an SNI extension during the SSL/TLS handshake and disables host name checking for Server Name Indication (SNI) during SSL/TLS handshakes.

org.apereo.cas.configuration.model.core.web.jetty.CasEmbeddedJettyProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

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.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.server.jetty.sni-host-check=true

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  server: 
    jetty: 
      sni-host-check: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.server.jetty.sni-host-check="true" -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as 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.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVER_JETTY_SNI_HOST_CHECK="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.server.jetty.sni-host-check="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

_{The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

server.jetty.accesslog.append=false

Append to log.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Accesslog.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.append=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      append: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.append="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_APPEND="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.append="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.accesslog.custom-format=

Custom log format, see org.eclipse.jetty.server.CustomRequestLog. If defined, overrides the "format" configuration key.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Accesslog.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.custom-format=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      custom-format: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.custom-format="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_CUSTOM_FORMAT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.custom-format="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.accesslog.date-format=

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.date-format=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      date-format: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.date-format="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_DATE_FORMAT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.date-format="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: server.jetty.accesslog.custom-format.

server.jetty.accesslog.enabled=false

Enable access log.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Accesslog.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.enabled=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.accesslog.extended-format=

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.extended-format=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      extended-format: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.extended-format="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_EXTENDED_FORMAT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.extended-format="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: server.jetty.accesslog.format.

server.jetty.accesslog.file-date-format=

Date format to place in log file name.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Accesslog.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.file-date-format=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      file-date-format: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.file-date-format="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_FILE_DATE_FORMAT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.file-date-format="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.accesslog.filename=

Log filename. If not specified, logs redirect to "System.err".

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Accesslog.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.filename=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      filename: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.filename="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_FILENAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.filename="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.accesslog.format=ncsa

Log format.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Accesslog.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.format=ncsa

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      format: "ncsa"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.format="ncsa" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_FORMAT="ncsa"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.format="ncsa"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.accesslog.ignore-paths=

Request paths that should not be logged.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Accesslog.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.ignore-paths=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      ignore-paths: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.ignore-paths="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_IGNORE_PATHS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.ignore-paths="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.accesslog.locale=

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.locale=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      locale: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.locale="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_LOCALE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.locale="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: server.jetty.accesslog.custom-format.

server.jetty.accesslog.log-cookies=

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.log-cookies=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      log-cookies: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.log-cookies="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_LOG_COOKIES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.log-cookies="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: server.jetty.accesslog.custom-format.

server.jetty.accesslog.log-latency=

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.log-latency=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      log-latency: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.log-latency="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_LOG_LATENCY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.log-latency="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: server.jetty.accesslog.custom-format.

server.jetty.accesslog.log-server=

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.log-server=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      log-server: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.log-server="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_LOG_SERVER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.log-server="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: server.jetty.accesslog.custom-format.

server.jetty.accesslog.retention-period=31

Number of days before rotated log files are deleted.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Accesslog.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.retention-period=31

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      retention-period: "31"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.retention-period="31" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_RETENTION_PERIOD="31"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.retention-period="31"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.accesslog.time-zone=

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.accesslog.time-zone=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    accesslog: 
      time-zone: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.accesslog.time-zone="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_ACCESSLOG_TIME_ZONE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.accesslog.time-zone="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: server.jetty.accesslog.custom-format.

server.jetty.connection-idle-timeout=

Time that the connection can be idle before it is closed.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.connection-idle-timeout=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    connection-idle-timeout: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.connection-idle-timeout="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_CONNECTION_IDLE_TIMEOUT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.connection-idle-timeout="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.max-connections=-1

Maximum number of connections that the server accepts and processes at any given time.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.max-connections=-1

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    max-connections: "-1"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.max-connections="-1" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_MAX_CONNECTIONS="-1"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.max-connections="-1"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.max-form-keys=1000

Maximum number of form keys.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.max-form-keys=1000

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    max-form-keys: "1000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.max-form-keys="1000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_MAX_FORM_KEYS="1000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.max-form-keys="1000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.max-http-form-post-size=200000B

Maximum size of the form content in any HTTP post request.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.max-http-form-post-size=200000B

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    max-http-form-post-size: "200000B"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.max-http-form-post-size="200000B" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_MAX_HTTP_FORM_POST_SIZE="200000B"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.max-http-form-post-size="200000B"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.max-http-post-size=

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.max-http-post-size=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    max-http-post-size: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.max-http-post-size="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_MAX_HTTP_POST_SIZE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.max-http-post-size="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: server.jetty.max-http-form-post-size.

server.jetty.max-http-response-header-size=8KB

Maximum size of the HTTP response header.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.max-http-response-header-size=8KB

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    max-http-response-header-size: "8KB"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.max-http-response-header-size="8KB" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_MAX_HTTP_RESPONSE_HEADER_SIZE="8KB"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.max-http-response-header-size="8KB"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.threads.acceptors=-1

Number of acceptor threads to use. When the value is -1, the default, the number of acceptors is derived from the operating environment.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Threads.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.threads.acceptors=-1

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    threads: 
      acceptors: "-1"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.threads.acceptors="-1" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_THREADS_ACCEPTORS="-1"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.threads.acceptors="-1"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.threads.idle-timeout=60000ms

Maximum thread idle time.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Threads.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.threads.idle-timeout=60000ms

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    threads: 
      idle-timeout: "60000ms"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.threads.idle-timeout="60000ms" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_THREADS_IDLE_TIMEOUT="60000ms"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.threads.idle-timeout="60000ms"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.threads.max=200

Maximum number of threads. Doesn't have an effect if virtual threads are enabled.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Threads.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.threads.max=200

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    threads: 
      max: "200"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.threads.max="200" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_THREADS_MAX="200"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.threads.max="200"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.threads.max-queue-capacity=

Maximum capacity of the thread pool's backing queue. A default is computed based on the threading configuration.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Threads.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.threads.max-queue-capacity=...

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    threads: 
      max-queue-capacity: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.threads.max-queue-capacity="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_THREADS_MAX_QUEUE_CAPACITY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.threads.max-queue-capacity="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.threads.min=8

Minimum number of threads. Doesn't have an effect if virtual threads are enabled.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Threads.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.threads.min=8

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    threads: 
      min: "8"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.threads.min="8" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_THREADS_MIN="8"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.threads.min="8"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

server.jetty.threads.selectors=-1

Number of selector threads to use. When the value is -1, the default, the number of selectors is derived from the operating environment.

org.springframework.boot.autoconfigure.web.ServerProperties$Jetty$Threads.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

server.jetty.threads.selectors=-1

CAS properties can be specified using the YAML syntax:

server: 
  jetty: 
    threads: 
      selectors: "-1"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dserver.jetty.threads.selectors="-1" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SERVER_JETTY_THREADS_SELECTORS="-1"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --server.jetty.threads.selectors="-1"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

# Append to log.
# server.jetty.accesslog.append=false

# Custom log format, see org.eclipse.jetty.server.CustomRequestLog.
# server.jetty.accesslog.custom-format=

# 
# server.jetty.accesslog.date-format=

# Enable access log.
# server.jetty.accesslog.enabled=false

# 
# server.jetty.accesslog.extended-format=

# Date format to place in log file name.
# server.jetty.accesslog.file-date-format=

# Log filename.
# server.jetty.accesslog.filename=

# Log format.
# server.jetty.accesslog.format=ncsa

# Request paths that should not be logged.
# server.jetty.accesslog.ignore-paths=

# 
# server.jetty.accesslog.locale=

# 
# server.jetty.accesslog.log-cookies=

# 
# server.jetty.accesslog.log-latency=

# 
# server.jetty.accesslog.log-server=

# Number of days before rotated log files are deleted.
# server.jetty.accesslog.retention-period=31

# 
# server.jetty.accesslog.time-zone=

# Time that the connection can be idle before it is closed.
# server.jetty.connection-idle-timeout=

# Maximum number of connections that the server accepts and processes at any given time.
# server.jetty.max-connections=-1

# Maximum number of form keys.
# server.jetty.max-form-keys=1000

# Maximum size of the form content in any HTTP post request.
# server.jetty.max-http-form-post-size=200000B

# 
# server.jetty.max-http-post-size=

# Maximum size of the HTTP response header.
# server.jetty.max-http-response-header-size=8KB

# Number of acceptor threads to use.
# server.jetty.threads.acceptors=-1

# Maximum thread idle time.
# server.jetty.threads.idle-timeout=60000ms

# Maximum number of threads.
# server.jetty.threads.max=200

# Maximum capacity of the thread pool's backing queue.
# server.jetty.threads.max-queue-capacity=

# Minimum number of threads.
# server.jetty.threads.min=8

# Number of selector threads to use.
# server.jetty.threads.selectors=-1

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.

Note

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.