From 851a7c7eb7aebfb6d0b2d756b4377d8e325efd3f Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Wed, 23 Jul 2014 17:22:17 +0100 Subject: [PATCH] Add text of new section on maintaining libraries. --- doc/library-configuration.txt | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/doc/library-configuration.txt b/doc/library-configuration.txt index 672cb18..040bf73 100644 --- a/doc/library-configuration.txt +++ b/doc/library-configuration.txt @@ -17,9 +17,39 @@ available targets to use. 1. Maintaining the library -------------------------- -### and so that a library of targets -is available, maintained using an instance of MKAdmin (often -http://mkc-admin.indexdata.com/console/) +The service proxy accesses sets of targets that are known as +"libraries". In general, each customer will have their own library, +though some standard libraries may be shared between many customers -- +for example, a library containing all open-access academic journals. +A library can also contain other configuration information, including +the set of categories by which targets are classified for the library. + +Libraries are maintained using MKAdmin (MasterKey +Admin). Specifically, those used by MKWS are generally maintained on +the "MKC Admin" installation at + http://mkx-admin.indexdata.com/console/ + +In general, Index Data will create a library for each customer, then +give the customer a username/password pair that they can use to enter +MKAdmin and administrate that library. + +Once logged in, customers can select which targets to include (from +the list of several thousand that MKAdmin knows about), and make +customer-specific modifications -- e.g. overriding the titles of the +targets. + +Most importantly, customers' administrators can add authentication +credentials that the Service Proxy will used on their behalf when +accessing subscription resources. Note that IT IS THEN CRUICIAL TO +SECURE THE LIBRARY FROM USE BY UNAUTHORISED CLIENTS, otherwise the +customer's paid subscriptions will be exploited. + +Access to libraries is managed by creating one or more "User Access" +records in MKAdmin, under the tab of that name. Each of these records +provides a combination of credentials and other data that allow an +incoming MKWS client to be identified as having legitimate access to +the library. The authentication process, described below, works by +searching for a matching User Access record. 2. Authenticating onto the library -- 1.7.10.4