From da7260e6f7ca92414c4a878582ca30abe5208b02 Mon Sep 17 00:00:00 2001 From: oajulianclementson <51331324+oajulianclementson@users.noreply.github.com> Date: Fri, 24 Sep 2021 19:10:34 +0100 Subject: [PATCH] LP#1842297: OpenAthens documentation updates --- .../Administration/OpenAthens_SignOn.adoc | 36 +++++++++++++--------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/docs/RELEASE_NOTES_NEXT/Administration/OpenAthens_SignOn.adoc b/docs/RELEASE_NOTES_NEXT/Administration/OpenAthens_SignOn.adoc index 87ed3f06f0..b3c8ab4958 100644 --- a/docs/RELEASE_NOTES_NEXT/Administration/OpenAthens_SignOn.adoc +++ b/docs/RELEASE_NOTES_NEXT/Administration/OpenAthens_SignOn.adoc @@ -1,10 +1,14 @@ -Configuring sign-on to OpenAthens -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If your institution uses OpenAthens single sign-on, you can configure Evergreen -to link with OpenAthens. This will let patrons connect to OpenAthens resources -seamlessly once they have logged in to Evergreen. Patrons are automatically -assigned an OpenAthens identity dynamically based on their Evergreen login, -and do not need accounts created manually in OpenAthens. += Configuring sign-on to OpenAthens = +:toc: + +== Purpose == + +If your institution uses OpenAthens, you can configure Evergreen to sign +patrons in to OpenAthens using their Evergreen account. This will let them +connect to OpenAthens resources seamlessly once they have logged in to +Evergreen. Patrons are assigned an OpenAthens identity dynamically based +on their Evergreen login, and do not need accounts created manually in +OpenAthens. Registering your Evergreen installation with the OpenAthens service +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @@ -13,7 +17,7 @@ complete the following steps: . Register a local authentication connection for Evergreen: .. Go to *Management* -> *Connections*. - .. Under *Local authentication* click *Add*. + .. Under *Local authentication* click *Create*. .. In the wizard that appears, select *Evergreen* as the local authentication system type (or *API* if Evergreen is not listed) and click *Configure*. .. For *Display name*, enter the name of your Evergreen portal that your @@ -27,7 +31,7 @@ complete the following steps: *Connection URI* that have been generated. You will need these when configuring Evergreen. . Generate an API key: - .. Go to *Management* -> *API keys* and click *Add*. + .. Go to *Management* -> *API keys* and click *Create*. .. For *Name*, enter 'Evergreen' or whatever name you use for your Evergreen portal internally, and click *Save*. .. Take a copy of the 36-character key that has been generated. You will need @@ -52,9 +56,9 @@ OpenAthens sign-on configuration normally equates to a single *domain* in the OpenAthens service. If in doubt refer to your OpenAthens account manager or implementation partner. * *Active* - Enable this connection (enabled by default). N.B. Evergreen - does not support more than one active connection to OpenAthens at a time. If - more than one connection is added here, Evergreen will use only the _first_ - connection that has *Active* enabled. + does not support more than one active connection to OpenAthens at a time per + organisation. If more than one connection is added per organisation, + Evergreen will use only the _first_ connection that has *Active* enabled. * *API key* - the 36-character OpenAthens *API key* that was generated in step 2 above. * *Connection ID* - the numerical *Connection ID* that was generated for the @@ -143,8 +147,12 @@ sample data set) |the patron's barcode |=== -Network access -++++++++++++++ +Click 'Save' to finish creating the connection. (If you can't see the +connection you just created for a branch library, enable the "+ Descendants" +option.) + +== Network access - server == + As part of the sign-on process, Evergreen makes a connection to the OpenAthens service to transfer details of the user that is signing on. This data does not go via the user's browser, to avoid revealing the private API key and to avoid -- 2.11.0