README.md 1.2 KB
Newer Older
Misagh Moayyed's avatar
Misagh Moayyed committed
1
CAS Overlay Template
Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
2
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. The CAS services management overlay is available [here](https://github.com/Jasig/cas-services-management-overlay).
Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
5
6
7

# Versions
```xml
Misagh Moayyed's avatar
Misagh Moayyed committed
8
<cas.version>5.0.0</cas.version>
Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
9
10
```

Misagh Moayyed's avatar
Misagh Moayyed committed
11
# Requirements
Misagh Moayyed's avatar
Misagh Moayyed committed
12
* JDK 1.8+
Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
13

14
15
# Configuration

Misagh Moayyed's avatar
Misagh Moayyed committed
16
The `etc` directory contains the configuration files and directories that need to be copied to `/etc/cas`.
17

Misagh Moayyed's avatar
Misagh Moayyed committed
18
19
20
21
22
23
24
25
Note that the `config` directory is expected to turn into a local `git` repository. 
To do so, execute the following commands:

```bash
cd /etc/cas/config
git init
```

Misagh Moayyed's avatar
Misagh Moayyed committed
26
27
28
# Build

```bash
Misagh Moayyed's avatar
Misagh Moayyed committed
29
./mvnw[.bat] clean package
Misagh Moayyed's avatar
Misagh Moayyed committed
30
31
```

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

Misagh Moayyed's avatar
Misagh Moayyed committed
34
35
36
37
## Embedded Tomcat

- 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
38

Misagh Moayyed's avatar
Misagh Moayyed committed
39
Then, run:
Misagh Moayyed's avatar
Misagh Moayyed committed
40
41

```bash
Misagh Moayyed's avatar
Misagh Moayyed committed
42
java -jar target/cas.war
Misagh Moayyed's avatar
Misagh Moayyed committed
43
44
45
```

CAS will be available at:
Misagh Moayyed's avatar
Misagh Moayyed committed
46

Misagh Moayyed's avatar
Misagh Moayyed committed
47
48
* `http://cas.server.name:8080/cas`
* `https://cas.server.name:8443/cas`
Misagh Moayyed's avatar
Misagh Moayyed committed
49

Misagh Moayyed's avatar
Misagh Moayyed committed
50
## External
Misagh Moayyed's avatar
Misagh Moayyed committed
51
Deploy resultant `target/cas.war`  to a servlet container of choice.