README.md 1.36 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. 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>6.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

Misagh Moayyed's avatar
Misagh Moayyed committed
14
* JDK 11
Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
15

16
17
# Configuration

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

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

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

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

Dmitriy Kopylenko's avatar
Dmitriy Kopylenko committed
28
29
# Deployment

Misagh Moayyed's avatar
Misagh Moayyed committed
30
31
- 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
32

Misagh Moayyed's avatar
Updated    
Misagh Moayyed committed
33
34
35
36
37
38
39
40
On a successful deployment via the following methods, CAS will be available at:

* `http://cas.server.name:8080/cas`
* `https://cas.server.name:8443/cas`

## Executable WAR

Run the CAS web application as an executable WAR.
Misagh Moayyed's avatar
Misagh Moayyed committed
41
42

```bash
Misagh Moayyed's avatar
Misagh Moayyed committed
43
./build.sh run
Misagh Moayyed's avatar
Misagh Moayyed committed
44
45
```

Hal Deadman's avatar
Hal Deadman committed
46
## Windows Build
Misagh Moayyed's avatar
Misagh Moayyed committed
47

Misagh Moayyed's avatar
Misagh Moayyed committed
48
If you are building on windows, try `build.cmd` instead of `build.sh`. Arguments are similar but for usage, run:
Hal Deadman's avatar
Hal Deadman committed
49
50
51
52
53

```
build.cmd help
```

Misagh Moayyed's avatar
Misagh Moayyed committed
54
## External
Misagh Moayyed's avatar
updated    
Misagh Moayyed committed
55

56
Deploy the binary web application file `cas.war` after a successful build to a servlet container of choice.
57