X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=1d654393e0781b156d7ea651cf30ab39d9723cc2;hb=f426841825d1f16c9080ad4fecb6c880ace9b521;hp=37518eb840963237b22584d0e09ade088840e125;hpb=a633ffa2e4ee92043a2ee6fe90acc9e48ce6a907;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 37518eb..1d65439 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -938,7 +938,7 @@ service_proxy_auth _global_ url If defined, this is the UR fetched once at the beginning of each session to authenticate the user and establish a session that encompasses a defined set of targets to search in. When not defined, the URL is assembled from `auth_hostname` or - `pp2_hostname`, `sp_auth_path`, `sp_auth_query` and + `pp2_hostname`, `pp2_path` or `sp_auth_path`, `sp_auth_query` and `sp_auth_credentials`. See the [Assembling Pazpar2 URLs](#assembling-pazpar2-urls) section below. @@ -974,10 +974,10 @@ sp_auth_credentials _global_ string If defined, this must be a initialisation. See the [Assembling Pazpar2 URLs](#assembling-pazpar2-urls) section below. -sp_auth_path _global_ string *Note 6* Part of the URL used for authentication. See the [Assembling Pazpar2 +sp_auth_path _global_ string Part of the URL used for authentication. See the [Assembling Pazpar2 URLs](#assembling-pazpar2-urls) section below. -sp_auth_query _global_ string *Note 7* Part of the URL used for authentication. See the [Assembling Pazpar2 +sp_auth_query _global_ string *Note 6* Part of the URL used for authentication. See the [Assembling Pazpar2 URLs](#assembling-pazpar2-urls) section below. target facet, string One of three ways to select which targets an auto-searching widgets uses. See @@ -1034,13 +1034,11 @@ customise the display than by providing a full HTML structure. 3. The default for `pp2_hostname` is `"sp-mkws.indexdata.com"` -4. The default for `pp2_path` is `"service-proxy"` +4. The default for `pp2_path` is `"service-proxy/"` 5. The default for `sort_options` is `[["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]` -6. The default for `sp_auth_path` is `"service-proxy/"`. - -7. The default for `sp_auth_query` is `"command=auth&action=perconfig"`. +6. The default for `sp_auth_query` is `"command=auth&action=perconfig"` ### Indirect settings @@ -1069,7 +1067,14 @@ invoked from the URL `http://example.com/magic/lookup/dinosaur` ### Assembling Pazpar2 URLs -FIXME describe how `pazpar2_url` is assembled from `pp2_hostname` and `pp2_path`; and how `service_proxy_auth` is assembled from +Most of MKWS's functionality is achieved by use of the Pazpar2 middleware. This is accessed on an endpoint URL which is usually +assembled from the two configuration sessings `pp2_hostname` and `pp2_path`. However, if for some reason an unusual Pazpar2 +endpoint must be used, that endpoint can be specified in the `pazpar2_url` setting, and that will be used instead. + +In the common case where Pazpar2 is accessed via the Service Proxy, an authentication call is made during initialisation. The call +is generally made to the same endpoint as the other requests. However, + +and how `service_proxy_auth` is assembled from `auth_hostname` or `pp2_hostname`, `sp_auth_path`, `sp_auth_query` and `sp_auth_credentials`. Language specification