Static Themes
CAS is configured to decorate views based on the theme
property of a given
registered service in the Service Registry. The theme that is activated via
this method will still preserve the default views for CAS but will apply
decorations such as CSS and Javascript to the views. The physical structure
of views cannot be modified via this method.
The following settings and properties are available from the CAS configuration catalog:
cas.theme.default-theme-name=cas-theme-default
The default theme name of this CAS deployment. The default theme file
|
cas.theme.param-name=theme
The parameter name used to switch themes.
|
cas.theme.name=
|
cas.theme.description=
|
Please review this guide to configure your build.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
To create a theme, please follow the below instructions:
- Add a
[theme_name].properties
placed to the root ofsrc/main/resources
folder. Contents of this file may contain the following settings:
Setting | Description | Value |
---|---|---|
cas.standard.css.file |
Path to theme CSS file; Multiple files may be comma-separated. | /themes/[theme_name]/css/cas.css |
cas.standard.js.file |
Path to theme Javascript file; Multiple files may be comma-separated. | /themes/[theme_name]/js/js/css |
cas.standard.fragments.head |
Names of fragments found in custom.html fragment, included in the layout <head> tag |
Blank |
cas.logo.file |
Path to theme logo to display via the common layout. | /images/logo.png |
cas.drawer-menu.enabled |
Decide whether drawer menu should be displayed. | true |
cas.theme.name |
Theme name used in various titles/captions. | Example Theme |
cas.theme.description |
Theme description used in various titles/captions. | Example Theme Description |
cas.pm-links.enabled |
Whether password management/reset links should be displayed. | true |
cas.login-form.enabled |
When the CAS login form should be displayed. | true |
cas.notifications-menu.enabled |
Enable and display the notifications menu. | true |
cas.favicon.file |
Path to theme favicon file. | /themes/example/images/favicon.ico |
cas.hero-banner.file |
Path to a “hero” styled image/logo on the login form. | /themes/example/images/hero.png |
cas.js.core.enabled |
Whether core/default Javascript libraries should be included. | true |
cas.css.core.enabled=true |
Whether core/default CSS libraries should be included. | true |
cas.successful-login.display-attributes |
Whether attributes/applications should be displayed on login. | true |
cas.public-workstation.enabled |
Whether user can indicate a public workstation option on login. | false |
cas.warn-on-redirect.enabled |
Whether user should be warned prior to redirects to applications. | false |
cas.browser-storage.show-progress |
Whether to display progress when reading/writing browser storage data. | true |
cas.footer.show |
Whether to display the CAS footer. | true |
- Create the directory
src/main/resources/static/themes/[theme_name]
. Put the theme-specificcas.css
andcas.js
inside the appropriate directories forcss
andjs
. - Specify
[theme_name]
for the service definition under thetheme
property.
1
2
3
4
5
6
7
{
"@class" : "org.apereo.cas.services.CasRegisteredService",
"serviceId" : "^https://www.example.org",
"name" : "MyTheme",
"theme" : "[theme_name]",
"id" : 1000
}
Values can use the Spring Expression Language syntax.