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.

User Interface - Thymeleaf

CAS uses Thymeleaf for its markup rendering engine. Each template is decorated by layout.html template file, which provides a layout structure for the template’s content. Individual components optimized for re-use among multiple templates are stored in the src/main/resources/templates/fragments folder, and referenced by the templates in src/main/resources/templates.

Refer to the Thymeleaf documentation for more information on its use and syntax.

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.}

spring.thymeleaf.cache=true

Whether to enable template caching.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.cache=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:

spring: 
  thymeleaf: 
    cache: "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 -Dspring.thymeleaf.cache="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 SPRING_THYMELEAF_CACHE="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 --spring.thymeleaf.cache="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.

spring.thymeleaf.check-template=true

Whether to check that the template exists before rendering it.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.check-template=true

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    check-template: "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 -Dspring.thymeleaf.check-template="true" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_CHECK_TEMPLATE="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 --spring.thymeleaf.check-template="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.

spring.thymeleaf.check-template-location=true

Whether to check that the templates location exists.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.check-template-location=true

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    check-template-location: "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 -Dspring.thymeleaf.check-template-location="true" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_CHECK_TEMPLATE_LOCATION="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 --spring.thymeleaf.check-template-location="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.

spring.thymeleaf.enable-spring-el-compiler=false

Enable the SpringEL compiler in SpringEL expressions.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.enable-spring-el-compiler=...

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    enable-spring-el-compiler: "..."

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 -Dspring.thymeleaf.enable-spring-el-compiler="..." -jar build/libs/cas.war

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

export SPRING_THYMELEAF_ENABLE_SPRING_EL_COMPILER="..."

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 --spring.thymeleaf.enable-spring-el-compiler="..."

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.

spring.thymeleaf.enabled=true

Whether to enable Thymeleaf view resolution for Web frameworks.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    enabled: "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 -Dspring.thymeleaf.enabled="true" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_ENABLED="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 --spring.thymeleaf.enabled="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.

spring.thymeleaf.encoding=UTF-8

Template files encoding.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.encoding=UTF-8

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    encoding: "UTF-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 -Dspring.thymeleaf.encoding="UTF-8" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_ENCODING="UTF-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 --spring.thymeleaf.encoding="UTF-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.

spring.thymeleaf.excluded-view-names=

List of view names (patterns allowed) that should be excluded from resolution.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.excluded-view-names=...

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    excluded-view-names: "..."

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 -Dspring.thymeleaf.excluded-view-names="..." -jar build/libs/cas.war

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

export SPRING_THYMELEAF_EXCLUDED_VIEW_NAMES="..."

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 --spring.thymeleaf.excluded-view-names="..."

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.

spring.thymeleaf.mode=HTML

Template mode to be applied to templates. See also Thymeleaf's TemplateMode enum.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.mode=HTML

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    mode: "HTML"

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 -Dspring.thymeleaf.mode="HTML" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_MODE="HTML"

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 --spring.thymeleaf.mode="HTML"

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.

spring.thymeleaf.prefix=classpath:/templates/

Prefix that gets prepended to view names when building a URL.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.prefix=classpath:/templates/

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    prefix: "classpath:/templates/"

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 -Dspring.thymeleaf.prefix="classpath:/templates/" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_PREFIX="classpath:/templates/"

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 --spring.thymeleaf.prefix="classpath:/templates/"

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.

spring.thymeleaf.reactive.chunked-mode-view-names=

Comma-separated list of view names (patterns allowed) that should be the only ones executed in CHUNKED mode when a max chunk size is set.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Reactive.

_{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:

spring.thymeleaf.reactive.chunked-mode-view-names=...

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    reactive: 
      chunked-mode-view-names: "..."

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 -Dspring.thymeleaf.reactive.chunked-mode-view-names="..." -jar build/libs/cas.war

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

export SPRING_THYMELEAF_REACTIVE_CHUNKED_MODE_VIEW_NAMES="..."

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 --spring.thymeleaf.reactive.chunked-mode-view-names="..."

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.

spring.thymeleaf.reactive.full-mode-view-names=

Comma-separated list of view names (patterns allowed) that should be executed in FULL mode even if a max chunk size is set.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Reactive.

_{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:

spring.thymeleaf.reactive.full-mode-view-names=...

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    reactive: 
      full-mode-view-names: "..."

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 -Dspring.thymeleaf.reactive.full-mode-view-names="..." -jar build/libs/cas.war

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

export SPRING_THYMELEAF_REACTIVE_FULL_MODE_VIEW_NAMES="..."

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 --spring.thymeleaf.reactive.full-mode-view-names="..."

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.

spring.thymeleaf.reactive.max-chunk-size=0B

Maximum size of data buffers used for writing to the response. Templates will execute in CHUNKED mode by default if this is set.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Reactive.

_{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:

spring.thymeleaf.reactive.max-chunk-size=0B

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    reactive: 
      max-chunk-size: "0B"

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 -Dspring.thymeleaf.reactive.max-chunk-size="0B" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_REACTIVE_MAX_CHUNK_SIZE="0B"

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 --spring.thymeleaf.reactive.max-chunk-size="0B"

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.

spring.thymeleaf.reactive.media-types=text/htmlapplication/xhtml+xmlapplication/xmltext/xmlapplication/rss+xmlapplication/atom+xmlapplication/javascriptapplication/ecmascripttext/javascripttext/ecmascriptapplication/jsontext/csstext/plaintext/event-stream

Media types supported by the view technology.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Reactive.

_{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:

spring.thymeleaf.reactive.media-types=text/htmlapplication/xhtml+xmlapplication/xmltext/xmlapplication/rss+xmlapplication/atom+xmlapplication/javascriptapplication/ecmascripttext/javascripttext/ecmascriptapplication/jsontext/csstext/plaintext/event-stream

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    reactive: 
      media-types: "["text/html", "application/xhtml+xml", "application/xml", "text/xml", "application/rss+xml", "application/atom+xml", "application/javascript", "application/ecmascript", "text/javascript", "text/ecmascript", "application/json", "text/css", "text/plain", "text/event-stream"]"

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 -Dspring.thymeleaf.reactive.media-types="["text/html", "application/xhtml+xml", "application/xml", "text/xml", "application/rss+xml", "application/atom+xml", "application/javascript", "application/ecmascript", "text/javascript", "text/ecmascript", "application/json", "text/css", "text/plain", "text/event-stream"]" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_REACTIVE_MEDIA_TYPES="["text/html", "application/xhtml+xml", "application/xml", "text/xml", "application/rss+xml", "application/atom+xml", "application/javascript", "application/ecmascript", "text/javascript", "text/ecmascript", "application/json", "text/css", "text/plain", "text/event-stream"]"

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 --spring.thymeleaf.reactive.media-types="["text/html", "application/xhtml+xml", "application/xml", "text/xml", "application/rss+xml", "application/atom+xml", "application/javascript", "application/ecmascript", "text/javascript", "text/ecmascript", "application/json", "text/css", "text/plain", "text/event-stream"]"

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.

spring.thymeleaf.render-hidden-markers-before-checkboxes=false

Whether hidden form inputs acting as markers for checkboxes should be rendered before the checkbox element itself.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.render-hidden-markers-before-checkboxes=...

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    render-hidden-markers-before-checkboxes: "..."

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 -Dspring.thymeleaf.render-hidden-markers-before-checkboxes="..." -jar build/libs/cas.war

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

export SPRING_THYMELEAF_RENDER_HIDDEN_MARKERS_BEFORE_CHECKBOXES="..."

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 --spring.thymeleaf.render-hidden-markers-before-checkboxes="..."

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.

spring.thymeleaf.servlet.content-type=text/html

Content-Type value written to HTTP responses.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Servlet.

_{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:

spring.thymeleaf.servlet.content-type=text/html

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    servlet: 
      content-type: "text/html"

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 -Dspring.thymeleaf.servlet.content-type="text/html" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_SERVLET_CONTENT_TYPE="text/html"

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 --spring.thymeleaf.servlet.content-type="text/html"

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.

spring.thymeleaf.servlet.produce-partial-output-while-processing=true

Whether Thymeleaf should start writing partial output as soon as possible or buffer until template processing is finished.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Servlet.

_{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:

spring.thymeleaf.servlet.produce-partial-output-while-processing=true

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    servlet: 
      produce-partial-output-while-processing: "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 -Dspring.thymeleaf.servlet.produce-partial-output-while-processing="true" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_SERVLET_PRODUCE_PARTIAL_OUTPUT_WHILE_PROCESSING="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 --spring.thymeleaf.servlet.produce-partial-output-while-processing="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.

spring.thymeleaf.suffix=.html

Suffix that gets appended to view names when building a URL.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.suffix=.html

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    suffix: ".html"

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 -Dspring.thymeleaf.suffix=".html" -jar build/libs/cas.war

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

export SPRING_THYMELEAF_SUFFIX=".html"

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 --spring.thymeleaf.suffix=".html"

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.

spring.thymeleaf.template-resolver-order=

Order of the template resolver in the chain. By default, the template resolver is first in the chain. Order start at 1 and should only be set if you have defined additional "TemplateResolver" beans.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.template-resolver-order=...

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    template-resolver-order: "..."

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 -Dspring.thymeleaf.template-resolver-order="..." -jar build/libs/cas.war

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

export SPRING_THYMELEAF_TEMPLATE_RESOLVER_ORDER="..."

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 --spring.thymeleaf.template-resolver-order="..."

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.

spring.thymeleaf.view-names=

List of view names (patterns allowed) that can be resolved.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

_{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:

spring.thymeleaf.view-names=...

CAS properties can be specified using the YAML syntax:

spring: 
  thymeleaf: 
    view-names: "..."

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 -Dspring.thymeleaf.view-names="..." -jar build/libs/cas.war

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

export SPRING_THYMELEAF_VIEW_NAMES="..."

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 --spring.thymeleaf.view-names="..."

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.

# Whether to enable template caching.
# spring.thymeleaf.cache=true

# Whether to check that the template exists before rendering it.
# spring.thymeleaf.check-template=true

# Whether to check that the templates location exists.
# spring.thymeleaf.check-template-location=true

# Enable the SpringEL compiler in SpringEL expressions.
# spring.thymeleaf.enable-spring-el-compiler=false

# Whether to enable Thymeleaf view resolution for Web frameworks.
# spring.thymeleaf.enabled=true

# Template files encoding.
# spring.thymeleaf.encoding=UTF-8

# List of view names (patterns allowed) that should be excluded from resolution.
# spring.thymeleaf.excluded-view-names=

# Template mode to be applied to templates.
# spring.thymeleaf.mode=HTML

# Prefix that gets prepended to view names when building a URL.
# spring.thymeleaf.prefix=classpath:/templates/

# Comma-separated list of view names (patterns allowed) that should be the only ones executed in CHUNKED mode when a max chunk size is set.
# spring.thymeleaf.reactive.chunked-mode-view-names=

# Comma-separated list of view names (patterns allowed) that should be executed in FULL mode even if a max chunk size is set.
# spring.thymeleaf.reactive.full-mode-view-names=

# Maximum size of data buffers used for writing to the response.
# spring.thymeleaf.reactive.max-chunk-size=0B

# Media types supported by the view technology.
# spring.thymeleaf.reactive.media-types=["text/html", "application/xhtml+xml", "application/xml", "text/xml", "application/rss+xml", "application/atom+xml", "application/javascript", "application/ecmascript", "text/javascript", "text/ecmascript", "application/json", "text/css", "text/plain", "text/event-stream"]

# Whether hidden form inputs acting as markers for checkboxes should be rendered before the checkbox element itself.
# spring.thymeleaf.render-hidden-markers-before-checkboxes=false

# Content-Type value written to HTTP responses.
# spring.thymeleaf.servlet.content-type=text/html

# Whether Thymeleaf should start writing partial output as soon as possible or buffer until template processing is finished.
# spring.thymeleaf.servlet.produce-partial-output-while-processing=true

# Suffix that gets appended to view names when building a URL.
# spring.thymeleaf.suffix=.html

# Order of the template resolver in the chain.
# spring.thymeleaf.template-resolver-order=

# List of view names (patterns allowed) that can be resolved.
# spring.thymeleaf.view-names=

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.