README.md 1.23 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/apereo/cas-services-management-overlay).
Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
5
6

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

Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
8
```xml
Misagh Moayyed's avatar
Misagh Moayyed committed
9
<cas.version>5.0.x</cas.version>
Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
10
11
```

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

15
16
# Configuration

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

Misagh Moayyed's avatar
Misagh Moayyed committed
19
20
# Build

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

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

To package the final web application, run:

Misagh Moayyed's avatar
Misagh Moayyed committed
29
```bash
Misagh Moayyed's avatar
Misagh Moayyed committed
30
./build.sh package
Misagh Moayyed's avatar
Misagh Moayyed committed
31
32
```

Misagh Moayyed's avatar
updated    
Misagh Moayyed committed
33
34
35
36
37
38
To update `SNAPSHOT` versions run:

```bash
./build.sh package -U
```

Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
39
40
# Deployment

Misagh Moayyed's avatar
Misagh Moayyed committed
41
42
## Embedded Tomcat

Misagh Moayyed's avatar
Misagh Moayyed committed
43
44
- 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
45

Misagh Moayyed's avatar
Misagh Moayyed committed
46
Then, run:
Misagh Moayyed's avatar
Misagh Moayyed committed
47
48

```bash
Misagh Moayyed's avatar
Misagh Moayyed committed
49
./build.sh run
Misagh Moayyed's avatar
Misagh Moayyed committed
50
51
52
```

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

Misagh Moayyed's avatar
Misagh Moayyed committed
54
55
* `http://cas.server.name:8080/cas`
* `https://cas.server.name:8443/cas`
Misagh Moayyed's avatar
Misagh Moayyed committed
56

Misagh Moayyed's avatar
Misagh Moayyed committed
57
## External
Misagh Moayyed's avatar
updated    
Misagh Moayyed committed
58

Misagh Moayyed's avatar
Misagh Moayyed committed
59
Deploy resultant `target/cas.war`  to a servlet container of choice.
Misagh Moayyed's avatar
Misagh Moayyed committed
60