README.md 1.41 KB
Newer Older
Misagh Moayyed's avatar
Misagh Moayyed committed
1
CAS Overlay Template
2
=======================
Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
3

Misagh Moayyed's avatar
Misagh Moayyed committed
4
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.
Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
5
6

# Versions
Misagh Moayyed's avatar
updated    
Misagh Moayyed committed
7

Misagh Moayyed's avatar
Misagh Moayyed committed
8
9
- CAS `6.0.x`
- JDK `11`
Misagh Moayyed's avatar
Misagh Moayyed committed
10

Misagh Moayyed's avatar
Misagh Moayyed committed
11
# Overview
12

Misagh Moayyed's avatar
Misagh Moayyed committed
13
14
The project structure contains two variants for Apache Maven and Gradle WAR overlays, inside `maven-overlay` and `gradle-overlay` respectively. You may invoke
build commands using the `build.sh` script to work with your chosen overlay using:
15

Misagh Moayyed's avatar
Misagh Moayyed committed
16
17
18
```bash
./build.sh [maven|gradle] [command]
```
Misagh Moayyed's avatar
Misagh Moayyed committed
19

Misagh Moayyed's avatar
updated    
Misagh Moayyed committed
20
21
22
23
24
25
To see what commands are available to the build script, run:

```bash
./build.sh help
```

Misagh Moayyed's avatar
Misagh Moayyed committed
26
27
28
29
30
# Configuration

- The `etc` directory contains the configuration files and directories that need to be copied to `/etc/cas/config`.
- The mechanics of the build are controlled for both Apache Maven and Gradle using the `build.properties` file.

Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
31
32
# Deployment

Misagh Moayyed's avatar
Misagh Moayyed committed
33
34
- Create a keystore file `thekeystore` under `/etc/cas`. Use the password `changeit` for both the keystore and the key/certificate entries.
- Ensure the keystore is loaded up with keys and certificates of the server.
Misagh Moayyed's avatar
Misagh Moayyed committed
35

Misagh Moayyed's avatar
Updated    
Misagh Moayyed committed
36
37
38
39
40
41
42
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.
Misagh Moayyed's avatar
Misagh Moayyed committed
43
44

```bash
Misagh Moayyed's avatar
Misagh Moayyed committed
45
./build.sh run
Misagh Moayyed's avatar
Misagh Moayyed committed
46
47
48
```

## External
Misagh Moayyed's avatar
updated    
Misagh Moayyed committed
49

Misagh Moayyed's avatar
Misagh Moayyed committed
50
Deploy the binary web application file `cas.war` after a successful build to a servlet container of choice.