Skip to content

Commit

Permalink
Update all permalinks in repo README.md and add guide for keys
Browse files Browse the repository at this point in the history
  • Loading branch information
cslzchen committed Sep 3, 2020
1 parent a57e09e commit f6c8cd3
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,22 @@ A legacy version can be found at [CAS Overlay](https://github.com/CenterForOpenS

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`.

Related settings in `cas.propeties` can be found [here](https://github.com/cslzchen/osf-cas/blob/f9a9e459248b4a28f6d5f84963e3265330436276/etc/cas/config/cas.properties#L52-L59).
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).

## CAS DB

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 `[email protected]` 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`.
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 `[email protected]` 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`.

## Signing and Encryption Keys

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.

## Authentication Delegation

### ORCiD Login

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
`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).
`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).

### `fakeCAS` Login

Expand All @@ -72,7 +76,7 @@ fakecas:
stdin_open: true
```

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

## Build and Run

Expand Down

0 comments on commit f6c8cd3

Please sign in to comment.