From c0e94d408510bb494675e801fd4fa539fdbce7c9 Mon Sep 17 00:00:00 2001 From: Remington Steed Date: Wed, 11 Mar 2015 17:23:57 -0400 Subject: [PATCH 1/1] LP#1413624 Docs: Move Access Handler docs to official docs This commit moves the new Access Handler doc file to the official docs folder, adds the file reference to the root.txt, changes the main header text for easier linking, adds the missing block delimiter lines around a code block, and adds a blank line at the end of another doc file to prevent the docs from running together. Signed-off-by: Remington Steed --- .../Apache => admin}/apache_access_handler.txt | 16 +++++++++------- docs/admin/apache_rewrite_tricks.txt | 1 + docs/root.txt | 3 +++ 3 files changed, 13 insertions(+), 7 deletions(-) rename docs/{TechRef/Apache => admin}/apache_access_handler.txt (91%) diff --git a/docs/TechRef/Apache/apache_access_handler.txt b/docs/admin/apache_access_handler.txt similarity index 91% rename from docs/TechRef/Apache/apache_access_handler.txt rename to docs/admin/apache_access_handler.txt index 324f3bde69..594393c93c 100644 --- a/docs/TechRef/Apache/apache_access_handler.txt +++ b/docs/admin/apache_access_handler.txt @@ -1,10 +1,10 @@ -Apache Access Handler: OpenILS::WWW::AccessHandler --------------------------------------------------- -This Perl module is intended for limiting patron access to configured locations -in Apache. These locations could be folder trees, static files, non-Evergreen -dynamic content, or other Apache features/modules. It is intended as a more -patron-oriented and transparent version of the OpenILS::WWW::Proxy and -OpenILS::WWW:Proxy::Authen modules. +Apache Access Handler Perl Module +--------------------------------- +The OpenILS::WWW::AccessHandler Perl module is intended for limiting patron +access to configured locations in Apache. These locations could be folder +trees, static files, non-Evergreen dynamic content, or other Apache +features/modules. It is intended as a more patron-oriented and transparent +version of the OpenILS::WWW::Proxy and OpenILS::WWW:Proxy::Authen modules. Instead of using Basic Authentication the AccessHandler module instead redirects to the OPAC for login. Once logged in additional checks can be performed, based @@ -17,11 +17,13 @@ on configured variables: Use of the module is a simple addition to a Location block in Apache: [source,conf] +---- PerlAccessHandler OpenILS::WWW::AccessHandler # For each option you wish to set: PerlSetVar OPTION "VALUE" +---- The available options are: diff --git a/docs/admin/apache_rewrite_tricks.txt b/docs/admin/apache_rewrite_tricks.txt index 2b96797f47..5a0eea5aca 100644 --- a/docs/admin/apache_rewrite_tricks.txt +++ b/docs/admin/apache_rewrite_tricks.txt @@ -145,3 +145,4 @@ RewriteRule (.*) /%{ENG:eglibid}$1 ---- Note that template files themselves cannot be replaced in that manner. + diff --git a/docs/root.txt b/docs/root.txt index 1becdc5eeb..b2698a31ce 100644 --- a/docs/root.txt +++ b/docs/root.txt @@ -159,6 +159,9 @@ include::admin/sip_server.txt[] include::admin/apache_rewrite_tricks.txt[] +include::admin/apache_access_handler.txt[] + + Using the Staff Client ====================== -- 2.43.2