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.

Embedded Servlet Container

Note that CAS itself ships with a number of embedded containers that allow the platform to be self-contained as much as possible. These embedded containers are an integral part of the CAS software, are maintained and updated usually for every release and surely are meant to and can be used in production deployments. You DO NOT need to, but can if you want to, configure and deploy to an externally configured container.

Configuration

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

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

_{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.servlet.application-display-name=application

Display name of the application.

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

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

server.servlet.application-display-name=application

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:

server: 
  servlet: 
    application-display-name: "application"

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.servlet.application-display-name="application" -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 SERVER_SERVLET_APPLICATION_DISPLAY_NAME="application"

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.servlet.application-display-name="application"

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.servlet.context-parameters=

Servlet context init parameters.

org.springframework.boot.autoconfigure.web.ServerProperties$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:

server.servlet.context-parameters=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    context-parameters: "..."

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.servlet.context-parameters="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_CONTEXT_PARAMETERS="..."

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.servlet.context-parameters="..."

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.servlet.context-path=

Context path of the application.

org.springframework.boot.autoconfigure.web.ServerProperties$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:

server.servlet.context-path=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    context-path: "..."

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.servlet.context-path="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_CONTEXT_PATH="..."

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.servlet.context-path="..."

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.servlet.encoding.charset=UTF-8

Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly.

org.springframework.boot.web.servlet.server.Encoding.

_{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.servlet.encoding.charset=UTF-8

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    encoding: 
      charset: "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 -Dserver.servlet.encoding.charset="UTF-8" -jar build/libs/cas.war

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

export SERVER_SERVLET_ENCODING_CHARSET="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 --server.servlet.encoding.charset="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.

server.servlet.encoding.enabled=true

Whether to enable http encoding support.

_{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.servlet.encoding.enabled=true

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    encoding: 
      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 -Dserver.servlet.encoding.enabled="true" -jar build/libs/cas.war

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

export SERVER_SERVLET_ENCODING_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 --server.servlet.encoding.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.

server.servlet.encoding.force=

Whether to force the encoding to the configured charset on HTTP requests and responses.

org.springframework.boot.web.servlet.server.Encoding.

_{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.servlet.encoding.force=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    encoding: 
      force: "..."

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.servlet.encoding.force="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_ENCODING_FORCE="..."

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.servlet.encoding.force="..."

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.servlet.encoding.force-request=

Whether to force the encoding to the configured charset on HTTP requests. Defaults to true when "force" has not been specified.

org.springframework.boot.web.servlet.server.Encoding.

_{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.servlet.encoding.force-request=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    encoding: 
      force-request: "..."

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.servlet.encoding.force-request="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_ENCODING_FORCE_REQUEST="..."

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.servlet.encoding.force-request="..."

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.servlet.encoding.force-response=

Whether to force the encoding to the configured charset on HTTP responses.

org.springframework.boot.web.servlet.server.Encoding.

_{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.servlet.encoding.force-response=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    encoding: 
      force-response: "..."

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.servlet.encoding.force-response="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_ENCODING_FORCE_RESPONSE="..."

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.servlet.encoding.force-response="..."

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.servlet.encoding.mapping=

Mapping of locale to charset for response encoding.

org.springframework.boot.web.servlet.server.Encoding.

_{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.servlet.encoding.mapping=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    encoding: 
      mapping: "..."

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.servlet.encoding.mapping="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_ENCODING_MAPPING="..."

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.servlet.encoding.mapping="..."

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.servlet.jsp.class-name=org.apache.jasper.servlet.JspServlet

Class name of the servlet to use for JSPs. If registered is true and this class * is on the classpath then it will be registered.

org.springframework.boot.web.servlet.server.Jsp.

_{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.servlet.jsp.class-name=org.apache.jasper.servlet.JspServlet

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    jsp: 
      class-name: "org.apache.jasper.servlet.JspServlet"

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.servlet.jsp.class-name="org.apache.jasper.servlet.JspServlet" -jar build/libs/cas.war

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

export SERVER_SERVLET_JSP_CLASS_NAME="org.apache.jasper.servlet.JspServlet"

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.servlet.jsp.class-name="org.apache.jasper.servlet.JspServlet"

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.servlet.jsp.init-parameters=

Init parameters used to configure the JSP servlet.

org.springframework.boot.web.servlet.server.Jsp.

_{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.servlet.jsp.init-parameters=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    jsp: 
      init-parameters: "..."

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.servlet.jsp.init-parameters="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_JSP_INIT_PARAMETERS="..."

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.servlet.jsp.init-parameters="..."

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.servlet.jsp.registered=true

Whether the JSP servlet is registered.

org.springframework.boot.web.servlet.server.Jsp.

_{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.servlet.jsp.registered=true

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    jsp: 
      registered: "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 -Dserver.servlet.jsp.registered="true" -jar build/libs/cas.war

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

export SERVER_SERVLET_JSP_REGISTERED="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 --server.servlet.jsp.registered="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.

server.servlet.path=/

Path of the main dispatcher 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:

server.servlet.path=/

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    path: "/"

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.servlet.path="/" -jar build/libs/cas.war

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

export SERVER_SERVLET_PATH="/"

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.servlet.path="/"

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: spring.mvc.servlet.path.

server.servlet.register-default-servlet=false

Whether to register the default Servlet with the container.

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

_{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.servlet.register-default-servlet=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    register-default-servlet: "..."

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.servlet.register-default-servlet="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_REGISTER_DEFAULT_SERVLET="..."

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.servlet.register-default-servlet="..."

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.servlet.session.cookie.comment=

Comment for the cookie.

_{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.servlet.session.cookie.comment=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      cookie: 
        comment: "..."

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.servlet.session.cookie.comment="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_COOKIE_COMMENT="..."

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.servlet.session.cookie.comment="..."

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 ERRORwithout a replacement setting.

server.servlet.session.cookie.domain=

Domain for the cookie.

org.springframework.boot.web.servlet.server.Session$Cookie.

_{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.servlet.session.cookie.domain=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      cookie: 
        domain: "..."

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.servlet.session.cookie.domain="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_COOKIE_DOMAIN="..."

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.servlet.session.cookie.domain="..."

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.servlet.session.cookie.http-only=

Whether to use "HttpOnly" cookies for the cookie.

org.springframework.boot.web.servlet.server.Session$Cookie.

_{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.servlet.session.cookie.http-only=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      cookie: 
        http-only: "..."

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.servlet.session.cookie.http-only="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_COOKIE_HTTP_ONLY="..."

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.servlet.session.cookie.http-only="..."

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.servlet.session.cookie.max-age=

Maximum age of the cookie. If a duration suffix is not specified, seconds will be used. A positive value indicates when the cookie expires relative to the current time. A value of 0 means the cookie should expire immediately. A negative value means no "Max-Age".

org.springframework.boot.web.servlet.server.Session$Cookie.

_{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.servlet.session.cookie.max-age=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      cookie: 
        max-age: "..."

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.servlet.session.cookie.max-age="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_COOKIE_MAX_AGE="..."

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.servlet.session.cookie.max-age="..."

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.servlet.session.cookie.name=

Name of the cookie.

org.springframework.boot.web.servlet.server.Session$Cookie.

_{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.servlet.session.cookie.name=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      cookie: 
        name: "..."

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.servlet.session.cookie.name="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_COOKIE_NAME="..."

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.servlet.session.cookie.name="..."

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.servlet.session.cookie.partitioned=

Whether the generated cookie carries the Partitioned attribute.

org.springframework.boot.web.servlet.server.Session$Cookie.

_{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.servlet.session.cookie.partitioned=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      cookie: 
        partitioned: "..."

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.servlet.session.cookie.partitioned="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_COOKIE_PARTITIONED="..."

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.servlet.session.cookie.partitioned="..."

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.servlet.session.cookie.path=

Path of the cookie.

org.springframework.boot.web.servlet.server.Session$Cookie.

_{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.servlet.session.cookie.path=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      cookie: 
        path: "..."

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.servlet.session.cookie.path="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_COOKIE_PATH="..."

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.servlet.session.cookie.path="..."

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.servlet.session.cookie.same-site=

SameSite setting for the cookie.

org.springframework.boot.web.servlet.server.Session$Cookie.

_{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.servlet.session.cookie.same-site=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      cookie: 
        same-site: "..."

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.servlet.session.cookie.same-site="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_COOKIE_SAME_SITE="..."

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.servlet.session.cookie.same-site="..."

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.servlet.session.cookie.secure=

Whether to always mark the cookie as secure.

org.springframework.boot.web.servlet.server.Session$Cookie.

_{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.servlet.session.cookie.secure=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      cookie: 
        secure: "..."

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.servlet.session.cookie.secure="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_COOKIE_SECURE="..."

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.servlet.session.cookie.secure="..."

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.servlet.session.persistent=false

Whether to persist session data between restarts.

org.springframework.boot.web.servlet.server.Session.

_{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.servlet.session.persistent=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      persistent: "..."

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.servlet.session.persistent="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_PERSISTENT="..."

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.servlet.session.persistent="..."

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.servlet.session.store-dir=

Directory used to store session data.

org.springframework.boot.web.servlet.server.Session.

_{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.servlet.session.store-dir=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      store-dir: "..."

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.servlet.session.store-dir="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_STORE_DIR="..."

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.servlet.session.store-dir="..."

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.servlet.session.timeout=30m

Session timeout. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.web.servlet.server.Session.

_{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.servlet.session.timeout=30m

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      timeout: "30m"

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.servlet.session.timeout="30m" -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_TIMEOUT="30m"

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.servlet.session.timeout="30m"

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.servlet.session.tracking-modes=

Session tracking modes.

org.springframework.boot.web.servlet.server.Session.

_{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.servlet.session.tracking-modes=...

CAS properties can be specified using the YAML syntax:

server: 
  servlet: 
    session: 
      tracking-modes: "..."

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.servlet.session.tracking-modes="..." -jar build/libs/cas.war

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

export SERVER_SERVLET_SESSION_TRACKING_MODES="..."

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.servlet.session.tracking-modes="..."

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.ssl.bundle=

The name of a configured SSL bundle.

org.springframework.boot.web.server.Ssl.

_{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.ssl.bundle=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    bundle: "..."

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.ssl.bundle="..." -jar build/libs/cas.war

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

export SERVER_SSL_BUNDLE="..."

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.ssl.bundle="..."

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.ssl.certificate=

Path to a PEM-encoded SSL certificate file.

org.springframework.boot.web.server.Ssl.

_{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.ssl.certificate=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    certificate: "..."

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.ssl.certificate="..." -jar build/libs/cas.war

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

export SERVER_SSL_CERTIFICATE="..."

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.ssl.certificate="..."

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.ssl.certificate-private-key=

Path to a PEM-encoded private key file for the SSL certificate.

org.springframework.boot.web.server.Ssl.

_{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.ssl.certificate-private-key=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    certificate-private-key: "..."

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.ssl.certificate-private-key="..." -jar build/libs/cas.war

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

export SERVER_SSL_CERTIFICATE_PRIVATE_KEY="..."

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.ssl.certificate-private-key="..."

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.ssl.ciphers=

Supported SSL ciphers.

org.springframework.boot.web.server.Ssl.

_{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.ssl.ciphers=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    ciphers: "..."

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.ssl.ciphers="..." -jar build/libs/cas.war

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

export SERVER_SSL_CIPHERS="..."

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.ssl.ciphers="..."

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.ssl.client-auth=

Client authentication mode. Requires a trust store.

org.springframework.boot.web.server.Ssl.

_{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.ssl.client-auth=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    client-auth: "..."

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.ssl.client-auth="..." -jar build/libs/cas.war

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

export SERVER_SSL_CLIENT_AUTH="..."

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.ssl.client-auth="..."

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.ssl.enabled=true

Whether to enable SSL support.

org.springframework.boot.web.server.Ssl.

_{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.ssl.enabled=true

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    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 -Dserver.ssl.enabled="true" -jar build/libs/cas.war

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

export SERVER_SSL_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 --server.ssl.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.

server.ssl.enabled-protocols=

Enabled SSL protocols.

org.springframework.boot.web.server.Ssl.

_{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.ssl.enabled-protocols=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    enabled-protocols: "..."

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.ssl.enabled-protocols="..." -jar build/libs/cas.war

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

export SERVER_SSL_ENABLED_PROTOCOLS="..."

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.ssl.enabled-protocols="..."

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.ssl.key-alias=

Alias that identifies the key in the key store.

org.springframework.boot.web.server.Ssl.

_{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.ssl.key-alias=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    key-alias: "..."

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.ssl.key-alias="..." -jar build/libs/cas.war

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

export SERVER_SSL_KEY_ALIAS="..."

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.ssl.key-alias="..."

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.ssl.key-password=

Password used to access the key in the key store.

org.springframework.boot.web.server.Ssl.

_{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.ssl.key-password=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    key-password: "..."

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.ssl.key-password="..." -jar build/libs/cas.war

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

export SERVER_SSL_KEY_PASSWORD="..."

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.ssl.key-password="..."

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.ssl.key-store=

Path to the key store that holds the SSL certificate (typically a jks file).

org.springframework.boot.web.server.Ssl.

_{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.ssl.key-store=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    key-store: "..."

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.ssl.key-store="..." -jar build/libs/cas.war

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

export SERVER_SSL_KEY_STORE="..."

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.ssl.key-store="..."

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.ssl.key-store-password=

Password used to access the key store.

org.springframework.boot.web.server.Ssl.

_{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.ssl.key-store-password=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    key-store-password: "..."

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.ssl.key-store-password="..." -jar build/libs/cas.war

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

export SERVER_SSL_KEY_STORE_PASSWORD="..."

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.ssl.key-store-password="..."

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.ssl.key-store-provider=

Provider for the key store.

org.springframework.boot.web.server.Ssl.

_{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.ssl.key-store-provider=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    key-store-provider: "..."

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.ssl.key-store-provider="..." -jar build/libs/cas.war

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

export SERVER_SSL_KEY_STORE_PROVIDER="..."

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.ssl.key-store-provider="..."

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.ssl.key-store-type=

Type of the key store.

org.springframework.boot.web.server.Ssl.

_{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.ssl.key-store-type=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    key-store-type: "..."

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.ssl.key-store-type="..." -jar build/libs/cas.war

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

export SERVER_SSL_KEY_STORE_TYPE="..."

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.ssl.key-store-type="..."

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.ssl.protocol=TLS

SSL protocol to use.

org.springframework.boot.web.server.Ssl.

_{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.ssl.protocol=TLS

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    protocol: "TLS"

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.ssl.protocol="TLS" -jar build/libs/cas.war

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

export SERVER_SSL_PROTOCOL="TLS"

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.ssl.protocol="TLS"

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.ssl.server-name-bundles=

Mapping of host names to SSL bundles for SNI configuration.

org.springframework.boot.web.server.Ssl.

_{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.ssl.server-name-bundles=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    server-name-bundles: "..."

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.ssl.server-name-bundles="..." -jar build/libs/cas.war

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

export SERVER_SSL_SERVER_NAME_BUNDLES="..."

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.ssl.server-name-bundles="..."

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.ssl.trust-certificate=

Path to a PEM-encoded SSL certificate authority file.

org.springframework.boot.web.server.Ssl.

_{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.ssl.trust-certificate=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    trust-certificate: "..."

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.ssl.trust-certificate="..." -jar build/libs/cas.war

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

export SERVER_SSL_TRUST_CERTIFICATE="..."

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.ssl.trust-certificate="..."

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.ssl.trust-certificate-private-key=

Path to a PEM-encoded private key file for the SSL certificate authority.

org.springframework.boot.web.server.Ssl.

_{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.ssl.trust-certificate-private-key=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    trust-certificate-private-key: "..."

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.ssl.trust-certificate-private-key="..." -jar build/libs/cas.war

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

export SERVER_SSL_TRUST_CERTIFICATE_PRIVATE_KEY="..."

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.ssl.trust-certificate-private-key="..."

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.ssl.trust-store=

Trust store that holds SSL certificates.

org.springframework.boot.web.server.Ssl.

_{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.ssl.trust-store=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    trust-store: "..."

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.ssl.trust-store="..." -jar build/libs/cas.war

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

export SERVER_SSL_TRUST_STORE="..."

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.ssl.trust-store="..."

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.ssl.trust-store-password=

Password used to access the trust store.

org.springframework.boot.web.server.Ssl.

_{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.ssl.trust-store-password=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    trust-store-password: "..."

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.ssl.trust-store-password="..." -jar build/libs/cas.war

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

export SERVER_SSL_TRUST_STORE_PASSWORD="..."

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.ssl.trust-store-password="..."

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.ssl.trust-store-provider=

Provider for the trust store.

org.springframework.boot.web.server.Ssl.

_{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.ssl.trust-store-provider=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    trust-store-provider: "..."

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.ssl.trust-store-provider="..." -jar build/libs/cas.war

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

export SERVER_SSL_TRUST_STORE_PROVIDER="..."

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.ssl.trust-store-provider="..."

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.ssl.trust-store-type=

Type of the trust store.

org.springframework.boot.web.server.Ssl.

_{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.ssl.trust-store-type=...

CAS properties can be specified using the YAML syntax:

server: 
  ssl: 
    trust-store-type: "..."

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.ssl.trust-store-type="..." -jar build/libs/cas.war

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

export SERVER_SSL_TRUST_STORE_TYPE="..."

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.ssl.trust-store-type="..."

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.

# Display name of the application.
# server.servlet.application-display-name=application

# Servlet context init parameters.
# server.servlet.context-parameters=

# Context path of the application.
# server.servlet.context-path=

# Charset of HTTP requests and responses.
# server.servlet.encoding.charset=UTF-8

# Whether to enable http encoding support.
# server.servlet.encoding.enabled=true

# Whether to force the encoding to the configured charset on HTTP requests and responses.
# server.servlet.encoding.force=

# Whether to force the encoding to the configured charset on HTTP requests.
# server.servlet.encoding.force-request=

# Whether to force the encoding to the configured charset on HTTP responses.
# server.servlet.encoding.force-response=

# Mapping of locale to charset for response encoding.
# server.servlet.encoding.mapping=

# Class name of the servlet to use for JSPs.
# server.servlet.jsp.class-name=org.apache.jasper.servlet.JspServlet

# Init parameters used to configure the JSP servlet.
# server.servlet.jsp.init-parameters=

# Whether the JSP servlet is registered.
# server.servlet.jsp.registered=true

# Path of the main dispatcher servlet.
# server.servlet.path=/

# Whether to register the default Servlet with the container.
# server.servlet.register-default-servlet=false

# Comment for the cookie.
# server.servlet.session.cookie.comment=

# Domain for the cookie.
# server.servlet.session.cookie.domain=

# Whether to use "HttpOnly" cookies for the cookie.
# server.servlet.session.cookie.http-only=

# Maximum age of the cookie.
# server.servlet.session.cookie.max-age=

# Name of the cookie.
# server.servlet.session.cookie.name=

# Whether the generated cookie carries the Partitioned attribute.
# server.servlet.session.cookie.partitioned=

# Path of the cookie.
# server.servlet.session.cookie.path=

# SameSite setting for the cookie.
# server.servlet.session.cookie.same-site=

# Whether to always mark the cookie as secure.
# server.servlet.session.cookie.secure=

# Whether to persist session data between restarts.
# server.servlet.session.persistent=false

# Directory used to store session data.
# server.servlet.session.store-dir=

# Session timeout.
# server.servlet.session.timeout=30m

# Session tracking modes.
# server.servlet.session.tracking-modes=

# The name of a configured SSL bundle.
# server.ssl.bundle=

# Path to a PEM-encoded SSL certificate file.
# server.ssl.certificate=

# Path to a PEM-encoded private key file for the SSL certificate.
# server.ssl.certificate-private-key=

# Supported SSL ciphers.
# server.ssl.ciphers=

# Client authentication mode.
# server.ssl.client-auth=

# Whether to enable SSL support.
# server.ssl.enabled=true

# Enabled SSL protocols.
# server.ssl.enabled-protocols=

# Alias that identifies the key in the key store.
# server.ssl.key-alias=

# Password used to access the key in the key store.
# server.ssl.key-password=

# Path to the key store that holds the SSL certificate (typically a jks file).
# server.ssl.key-store=

# Password used to access the key store.
# server.ssl.key-store-password=

# Provider for the key store.
# server.ssl.key-store-provider=

# Type of the key store.
# server.ssl.key-store-type=

# SSL protocol to use.
# server.ssl.protocol=TLS

# Mapping of host names to SSL bundles for SNI configuration.
# server.ssl.server-name-bundles=

# Path to a PEM-encoded SSL certificate authority file.
# server.ssl.trust-certificate=

# Path to a PEM-encoded private key file for the SSL certificate authority.
# server.ssl.trust-certificate-private-key=

# Trust store that holds SSL certificates.
# server.ssl.trust-store=

# Password used to access the trust store.
# server.ssl.trust-store-password=

# Provider for the trust store.
# server.ssl.trust-store-provider=

# Type of the trust store.
# server.ssl.trust-store-type=

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.

Execution

The CAS web application, once built, may be deployed in place with the embedded container via the following command:

java -jar /path/to/cas.war

Additionally, it is also possible to run CAS as a fully executable web application:

# chmod +x /path/to/cas.war
/path/to/cas.war

This is achieved via the build process of the deployment overlay where a launch script is inserted at the beginning of the web application artifact. If you wish to see and examine the script, run the following commands:

 # X is the number of lines from the beginning of the file
 head -n X /path/to.cas.war

Note that running CAS as a standalone and fully executable web application is supported on most Linux and OS X distributions. Other platforms such as Windows may require custom configuration.

The following embedded servlet containers are available:

Option	Reference
Apache Tomcat	Please see this guide.
Jetty	Please see this guide.
Undertow	Please see this guide.