From: Jeanette Lundgren Date: Wed, 10 May 2017 21:00:39 +0000 (-0400) Subject: Docs: LP#1673841 Fix formatting in Apache docs X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=5cf503208ddc9389b1585c0ca5375ec6d6aa6931;p=evergreen%2Ftadl.git Docs: LP#1673841 Fix formatting in Apache docs From Jeanette's comment on the bug: "I converted into a simple unordered list and it is easier to read, but the list bullet spacing makes for a long list. To conserve some scrolling, do you want me to put it in a table instead with 3 column headers (option | default | description)?" Signed-off-by: Remington Steed --- diff --git a/docs/admin/apache_access_handler.adoc b/docs/admin/apache_access_handler.adoc index 594393c93c..1831d183c4 100644 --- a/docs/admin/apache_access_handler.adoc +++ b/docs/admin/apache_access_handler.adoc @@ -28,35 +28,35 @@ Use of the module is a simple addition to a Location block in Apache: The available options are: OILSAccessHandlerLoginURL:: - Default: /eg/opac/login + - The page to redirect to when Login is needed +* Default: /eg/opac/login +* The page to redirect to when Login is needed OILSAccessHandlerLoginURLRedirectVar:: - Default: redirect_to + - The variable the login page wants the "destination" URL stored in +* Default: redirect_to +* The variable the login page wants the "destination" URL stored in OILSAccessHandlerFailURL:: - Default: + - URL to go to if Permission, Good Standing, or Home OU checks fail. If not set +* Default: +* URL to go to if Permission, Good Standing, or Home OU checks fail. If not set a 403 error is generated instead. To customize the 403 you could use an ErrorDocument statement. OILSAccessHandlerCheckOU:: - Default: + - Org Unit to check Permissions at and/or to load Referrer from. Can be a +* Default: +* Org Unit to check Permissions at and/or to load Referrer from. Can be a shortname or an ID. OILSAccessHandlerPermission:: - Default: + - Permission, or comma- or space-delimited set of permissions, the user must have to +* Default: +* Permission, or comma- or space-delimited set of permissions, the user must have to access the protected area. OILSAccessHandlerGoodStanding:: - Default: 0 + - If set to a true value the user must be both Active and not Barred. +* Default: 0 +* If set to a true value the user must be both Active and not Barred. OILSAccessHandlerHomeOU:: - Default: + - An Org Unit, or comma- or space-delimited set of Org Units, that the user's Home OU must +* Default: +* An Org Unit, or comma- or space-delimited set of Org Units, that the user's Home OU must be equal to or a descendant of to access this resource. Can be set to shortnames or IDs. OILSAccessHandlerReferrerSetting:: - Default: + - Library Setting to pull a forced referrer string out of, if set. +* Default: +* Library Setting to pull a forced referrer string out of, if set. As the AccessHandler module does not actually serve the content it is protecting, but instead merely hands control back to Apache when it is done