From 4654f0def60ff4d5b21a4cd4bdfd2c0fe58e1585 Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Thu, 31 Jul 2014 02:55:08 +0100 Subject: [PATCH] Move all headings down a level, so that this can be included in a larger document. --- doc/library-configuration.markdown | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/doc/library-configuration.markdown b/doc/library-configuration.markdown index e692a72..6ba5353 100644 --- a/doc/library-configuration.markdown +++ b/doc/library-configuration.markdown @@ -1,6 +1,5 @@ -% MKWS Target Selection -% Mike Taylor - +MKWS Target Selection +--------------------- MKWS accesses targets using the Pazpar2 metasearching engine. Although Pazpar2 can be used directly, using a statically configured set of @@ -14,8 +13,7 @@ MKWS application to that library, and how to choose which of the available targets to use. -Maintaining the library ------------------------ +### Maintaining the library The service proxy accesses sets of targets that are known as "libraries". In general, each customer will have their own library, @@ -53,8 +51,7 @@ the library. The authentication process, described below, works by searching for a matching User Access record. -Authenticating your MWKS application onto the library ------------------------------------------------------ +### Authenticating your MWKS application onto the library Some MKWS applications will be content to use the default library with its selection of targets. Most, though, will want to define their own @@ -66,7 +63,7 @@ unauthorised access. Setting up such a library is a process of several stages. -### Create the User Access account +#### Create the User Access account Log in to MKAdmin administrate your library: @@ -105,7 +102,7 @@ You can create multiple User Access records: for example, one that uses Referring URL, and another that uses a username/password pair to be used when running an application from a different URL. -### Tell the application to use the library +#### Tell the application to use the library In the HTML of the application, tell MKWS to authenticate on to the Service Proxy. When IP-based, referer-based or hostname-based @@ -121,7 +118,7 @@ authentication is used, this is very simple: And ensure that access to the MWKS application is from the correct Referrer URL or IP-range. -### (Optional): access by a different virtual hostname +#### (Optional): access by a different virtual hostname When hostname-based authentication is in use, it's necessary to access the Service Proxy as the correctly named virtual host. This can be @@ -135,7 +132,7 @@ URL containing that hostname, such as > TODO When changing the SP authentication URL, the Pazpar2 URL should > in general change along with it. -### (Optional): embed credentials for access to the library +#### (Optional): embed credentials for access to the library When credential-based authentication is in use (username and password), it's necessary to pass these credentials into the Service @@ -146,7 +143,7 @@ by setting the `service_proxy_auth` configuration item to a URL such as > TODO It should be possible to add the username and password to the > configuration without needing to repeat the rest of the URL. -### (Optional): conceal credentials from HTML source +#### (Optional): conceal credentials from HTML source Using a credential-based Service-Proxy authentication URL such as the one above reveals the the credentials to public view -- to anyone who @@ -173,8 +170,7 @@ yourname.com: (e.g. using a .htaccess file). -Choosing targets from the library ---------------------------------- +### Choosing targets from the library MKWS applications can choose what subset of the library's targets to use, by means of several alternative settings on individual widgets or -- 1.7.10.4