Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewPoppe committed Oct 22, 2023
1 parent 6727f3c commit ec87b77
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CAS Survey Login
# CAS Authenticator

This REDCap External Module enables the integration of CAS authentication in any survey.
This REDCap External Module enables the integration of CAS authentication in any survey, public report, or public dashboard.

## Installation

Expand All @@ -14,9 +14,14 @@ Install by downloading the latest release zip and unzipping in the modules direc
- **CAS Context**: Context of the CAS Server (e.g., `/cas`)
- **CAS Port**: Port of your CAS server (e.g., `443`)
- **CAS Server CA Cert File**: The PEM file containing your CAS server's cert (e.g., [cacert.pem](https://curl.se/docs/caextract.html))

- **HTTPS Override**: Check this if you experience the CAS server redirecting to http despite your REDCap server using https protocol.
-
#### Project configuration:

- **Enable logging**: Check this to enable logging of CAS authentication events in the project's logging module
- **Survey subsettings** (repeatable)
- **Survey**: The survey instrument CAS should be integrated with
- **ID Field**: Optional. This allows the EM to store the username of the person who authenticated. It should be a text field on the survey defined above
- **Event**: The specific event in which the CAS authentication should be enabled (leave blank to apply to all events)
- **Survey**: The survey instrument CAS should be integrated with
- **ID Field**: Optional. This allows the EM to store the username of the person who authenticated. It should be a text field on the survey defined above
- **Report**: The public report CAS should be integrated with (repeatable)
- **Dashboard**: The public dashboard CAS should be integrated with (repeatable)

0 comments on commit ec87b77

Please sign in to comment.