Configuration Management

The core foundations of CAS that deal with configuration management, settings and replication of changes across multiple CAS nodes are all entirely handled automatically via the Spring Cloud project. The strategies listed below present a very flexible and powerful way to manage CAS configuration for production deployments, by allowing the CAS adopter to ONLY keep track of settings required for their specific deployment concerns and leaving all else behind to be handled by the default CAS configuration.

The following strategies may be used to fully extend the CAS configuration model.

YAML or Properties?

CAS configuration allows for both YAML and Properties syntax in any of the below strategies used. It generally does not matter which syntax is used, but when working with Unicode strings as properties values it does matter. Spring loads properties files using the `ISO-8859-1` encoding. YAML files are loaded with UTF-8 encoding. If you are setting Unicode values try using a YAML configuration file.

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.

  • cas.server.name=https://cas.example.org:8443
  • Full name of the CAS server. This is the public-facing address of the CAS deployment and not the individual node address, in the event that CAS is clustered.

    org.apereo.cas.configuration.model.core.CasServerProperties.

  • cas.server.prefix=/cas
  • A concatenation of the server name plus the CAS context path. Deployments at root likely need to blank out this value.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.core.CasServerProperties.

  • cas.server.scope=example.org
  • The CAS Server scope.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.core.CasServerProperties.