Skip to content

Commit f6c8cd3

Browse files
committed
Update all permalinks in repo README.md and add guide for keys
1 parent a57e09e commit f6c8cd3

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,22 @@ A legacy version can be found at [CAS Overlay](https://github.com/CenterForOpenS
4343

4444
OSF CAS requires a working OSF running locally. Refer to OSF's [README-docker-compose.md](https://github.com/CenterForOpenScience/osf.io/blob/develop/README-docker-compose.md) for how to set up and run OSF with `docker-compose`. Must disable `fakeCAS` to free port `8080`.
4545

46-
Related settings in `cas.propeties` can be found [here](https://github.com/cslzchen/osf-cas/blob/f9a9e459248b4a28f6d5f84963e3265330436276/etc/cas/config/cas.properties#L52-L59).
46+
In `cas.propeties`, global JDBC settings can be found [here](https://github.com/cslzchen/osf-cas/blob/21bb277cc38b3364fd67a632c0bc7b7a6ffc9efd/etc/cas/config/cas.properties#L69-L73) and JPA specific settings can be found [here](https://github.com/cslzchen/osf-cas/blob/21bb277cc38b3364fd67a632c0bc7b7a6ffc9efd/etc/cas/config/cas.properties#L54-L60).
4747

4848
## CAS DB
4949

50-
OSF CAS is configured to use the [JPA Ticket Registry](https://apereo.github.io/cas/6.2.x/ticketing/Configuring-Ticketing-Components.html#ticket-registry) for durable ticket storage. Thus, a relational database is required. Set up a `PostgreSQL@9.6` server and update *JPA Ticket Registry* [settings](https://github.com/cslzchen/osf-cas/blob/f9a9e459248b4a28f6d5f84963e3265330436276/etc/cas/config/cas.properties#L67-L110) in `cas.propeties` accordingly. Must use a port other than the already occupied `5432`.
50+
OSF CAS is configured to use the [JPA Ticket Registry](https://apereo.github.io/cas/6.2.x/ticketing/Configuring-Ticketing-Components.html#ticket-registry) for durable ticket storage. Thus, a relational database is required. Set up a `PostgreSQL@9.6` server and update *JPA Ticket Registry* [settings](https://github.com/cslzchen/osf-cas/blob/21bb277cc38b3364fd67a632c0bc7b7a6ffc9efd/etc/cas/config/cas.properties#L65-L113) in `cas.propeties` accordingly. Must use a port other than the already occupied `5432`.
51+
52+
## Signing and Encryption Keys
53+
54+
Refer to [settings](https://github.com/cslzchen/osf-cas/blob/21bb277cc38b3364fd67a632c0bc7b7a6ffc9efd/etc/cas/config/cas.properties#L117-L133) in `cas.properties` for signing and encrypting client session and ticket granting cookie.
5155

5256
## Authentication Delegation
5357

5458
### ORCiD Login
5559

5660
Set up a developer app at [ORCiD](https://orcid.org/developer-tools) with `http://localhost:8080/login` and `http://192.168.168.167:8080/login` as *redirect URIs*. Update
57-
`cas.authn.pac4j.orcid.id` and `cas.authn.pac4j.orcid.secret` in `cas.properties` [settings](https://github.com/cslzchen/osf-cas/blob/f9a9e459248b4a28f6d5f84963e3265330436276/etc/cas/config/cas.properties#L163-L164).
61+
`cas.authn.pac4j.orcid.id` and `cas.authn.pac4j.orcid.secret` in `cas.properties` [settings](https://github.com/cslzchen/osf-cas/blob/21bb277cc38b3364fd67a632c0bc7b7a6ffc9efd/etc/cas/config/cas.properties#L186-L192).
5862

5963
### `fakeCAS` Login
6064

@@ -72,7 +76,7 @@ fakecas:
7276
stdin_open: true
7377
```
7478

75-
Related settings in `cas.propeties` can be found [here](https://github.com/cslzchen/osf-cas/blob/f9a9e459248b4a28f6d5f84963e3265330436276/etc/cas/config/cas.properties#L171-L174).
79+
Related settings in `cas.propeties` can be found [here](https://github.com/cslzchen/osf-cas/blob/21bb277cc38b3364fd67a632c0bc7b7a6ffc9efd/etc/cas/config/cas.properties#L196-L199).
7680

7781
## Build and Run
7882

0 commit comments

Comments
 (0)