Skip to content
Apereo CAS WAR Overlay template
Branch: master
Clone or download
Pull request Compare This branch is 222 commits ahead, 1 commit behind UniconLabs:master.
Type Name Latest commit message Commit time
Failed to load latest commit information.
etc/cas Allow logging level for spring boot admin client to be adjusted easily Dec 10, 2018
gradle bump gradle and jib Feb 13, 2019
src/main/jib/docker move commands to gradle Nov 27, 2018
.gitignore working on overlay Jul 30, 2018
LICENSE.txt Added Apache v2 license Jun 27, 2014 updated Jan 3, 2019
build.gradle bump gradle and jib Feb 13, 2019 Update Mar 4, 2019
gradlew bump versions to 6.1; up gradle Jan 3, 2019
settings.gradle work on native docker imaging Nov 9, 2018

CAS Overlay Template

Generic CAS WAR overlay to exercise the latest versions of CAS. This overlay could be freely used as a starting template for local CAS war overlays.


  • CAS 6.1.x
  • JDK 11


To build the project, use:

# Use --refresh-dependencies to force-update SNAPSHOT versions
./gradlew[.bat] clean build

To see what commands are available to the build script, run:

./gradlew[.bat] tasks

To launch into the CAS command-line shell:

./gradlew[.bat] downloadShell runShell

To fetch and overlay a CAS resource or view, use:

./gradlew[.bat] getResource -PresourceName=[resource-name]

To build a CAS Docker image via jib, use:

./gradlew[.bat] clean build jibDockerBuild

To list all available CAS views and templates:

./gradlew[.bat] listTemplateViews

To unzip and explode the CAS web application file:

./gradlew[.bat] explodeWar


  • The etc directory contains the configuration files and directories that need to be copied to /etc/cas/config.
./gradlew[.bat] copyCasConfiguration
  • The specifics of the build are controlled using the file.

Adding Modules

CAS modules may be specified under the dependencies block of the Gradle build script:

dependencies {
    compile "org.apereo.cas:cas-server-some-module:${project.casVersion}"

To collect the list of all project modules and dependencies:

./gradlew[.bat] allDependencies

Clear Gradle Cache

If you need to, on Linux/Unix systems, you can delete all the existing artifacts (artifacts and metadata) Gradle has downloaded using:

# Only do this when absolutely necessary
rm -rf $HOME/.gradle/caches/

Same strategy applies to Windows too, provided you switch $HOME to its equivalent in the above command.


  • Create a keystore file thekeystore under /etc/cas. Use the password changeit for both the keystore and the key/certificate entries. This can either be done using the JDK's keytool utility or via the following command:
./gradlew[.bat] createKeystore
  • Ensure the keystore is loaded up with keys and certificates of the server.

On a successful deployment via the following methods, CAS will be available at:


Executable WAR

Run the CAS web application as an executable WAR:

./gradlew[.bat] run

Debug the CAS web application as an executable WAR:

./gradlew[.bat] debug

Run the CAS web application as a standalone executable WAR:

./gradlew[.bat] clean executable


Deploy the binary web application file cas.war after a successful build to a servlet container of choice.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.