From ec87b770a61bdfbd072832078cbfcabae0c6ea0a Mon Sep 17 00:00:00 2001 From: AndrewPoppe Date: Sun, 22 Oct 2023 12:18:28 -0400 Subject: [PATCH] Update README --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ca5f050..06531cd 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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)