README.md 1.26 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
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
# Build

```bash
Misagh Moayyed's avatar
Misagh Moayyed committed
21
./mvnw[.bat] clean package
Misagh Moayyed's avatar
Misagh Moayyed committed
22
23
```

Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
24
25
# Deployment

Misagh Moayyed's avatar
Misagh Moayyed committed
26
27
## Embedded Tomcat

Misagh Moayyed's avatar
Misagh Moayyed committed
28
29
- 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
30

Misagh Moayyed's avatar
Misagh Moayyed committed
31
Then, run:
Misagh Moayyed's avatar
Misagh Moayyed committed
32
33

```bash
Misagh Moayyed's avatar
Misagh Moayyed committed
34
java -jar target/cas.war
Misagh Moayyed's avatar
Misagh Moayyed committed
35
36
37
```

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

Misagh Moayyed's avatar
Misagh Moayyed committed
39
40
* `http://cas.server.name:8080/cas`
* `https://cas.server.name:8443/cas`
Misagh Moayyed's avatar
Misagh Moayyed committed
41

Misagh Moayyed's avatar
Misagh Moayyed committed
42
43
44
45
46
### Remote Debugging

To configure remote debugging for the embedded Tomcat instance, execute:

```bash
Misagh Moayyed's avatar
updated    
Misagh Moayyed committed
47
./mvnw[.bat] clean package && java -Xdebug -Xrunjdwp:transport=dt_socket,address=5000,server=y,suspend=n -jar target/cas.war 
Misagh Moayyed's avatar
Misagh Moayyed committed
48
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.
Misagh Moayyed's avatar
Misagh Moayyed committed
52