Commit 31f6fb83 authored by damianofalcioni's avatar damianofalcioni

updated readme

parent cd45e234
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.
The project is a customized version of the CAS Overly Template with custom template for login and added support for LDAP authentication.
# Versions
- CAS `6.1.x`
- JDK `11`
# Overview
To build the project, use:
# Deployment Instructions
```bash
# Use --refresh-dependencies to force-update SNAPSHOT versions
./gradlew[.bat] clean build
```
To see what commands are available to the build script, run:
```bash
./gradlew[.bat] tasks
```
To launch into the CAS command-line shell:
```bash
./gradlew[.bat] downloadShell runShell
```
To fetch and overlay a CAS resource or view, use:
```bash
./gradlew[.bat] getResource -PresourceName=[resource-name]
```
To build a CAS Docker image via jib, use:
1) Deploy the application in Tomcat: extract cas.war in the Tomcat webapp folder (in linux by default under opt/tomcat/webapps/).
```bash
./gradlew[.bat] clean build jibDockerBuild
```
To list all available CAS views and templates:
```bash
./gradlew[.bat] listTemplateViews
```
2) Download the provided configuration available in the [etc folder of the project](https://git.boc-group.eu/olive/cas-overlay-template/tree/master/etc) into the root of your drive (eg. C:\ for windows users and / for linux users)
To unzip and explode the CAS web application file:
The CAS by default is configured to work with the default installed [LDAP](https://git.boc-group.eu/olive/ldap-config).<br>
Adapt the cas.properties file to change the default configuration.
```bash
./gradlew[.bat] explodeWar
```
# Configuration
# Build Instructions
- The `etc` directory contains the configuration files and directories that need to be copied to `/etc/cas/config`.
In order to build the cas.war file from the source provided in this project run the following command:
```bash
./gradlew[.bat] copyCasConfiguration
```
- The specifics of the build are controlled using the `gradle.properties` file.
## Adding Modules
CAS modules may be specified under the `dependencies` block of the [Gradle build script](build.gradle):
```gradle
dependencies {
compile "org.apereo.cas:cas-server-some-module:${project.casVersion}"
...
}
```
To collect the list of all project modules and dependencies:
```bash
./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:
```bash
# 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.
# Deployment
- 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:
```bash
./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:
* `https://cas.server.name:8443/cas`
## Executable WAR
Run the CAS web application as an executable WAR:
```bash
./gradlew[.bat] run
```
Debug the CAS web application as an executable WAR:
```bash
./gradlew[.bat] debug
```
Run the CAS web application as a *standalone* executable WAR:
```bash
./gradlew[.bat] clean executable
./gradlew[.bat] clean build
```
## External
Deploy the binary web application file `cas.war` after a successful build to a servlet container of choice.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment