Documentation for mod_authn_alias

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@178302 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/docs/manual/mod/mod_authn_alias.xml b/docs/manual/mod/mod_authn_alias.xml
new file mode 100644 (file)
index 0000000..fe667d7
--- /dev/null
+++ b/docs/manual/mod/mod_authn_alias.xml
@@ -0,0 +1,107 @@
+<?xml version="1.0"?>\r
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">\r
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>\r
+<!-- $LastChangedRevision: 151408 $ -->\r
+\r
+<!--\r
+ Copyright 2002-2005 The Apache Software Foundation or its licensors, as\r
+ applicable.\r
+\r
+ Licensed under the Apache License, Version 2.0 (the "License");\r
+ you may not use this file except in compliance with the License.\r
+ You may obtain a copy of the License at\r
+\r
+     http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+ Unless required by applicable law or agreed to in writing, software\r
+ distributed under the License is distributed on an "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ See the License for the specific language governing permissions and\r
+ limitations under the License.\r
+-->\r
+\r
+<modulesynopsis metafile="mod_authn_alias.xml.meta">\r
+\r
+<name>mod_authn_alias</name>\r
+<description>Provides the ability to create extended authentication \r
+    providers based on actual providers</description>\r
+<status>Extension</status>\r
+<sourcefile>mod_authn_alias.c</sourcefile>\r
+<identifier>authn_alias_module</identifier>\r
+<compatibility>Available in Apache 2.1 and later</compatibility>\r
+\r
+<summary>\r
+    <p>This module allows extended authentication providers to be created \r
+    within the configuration file and assigned an alias name.  The alias \r
+    providers can then be referenced through the directives \r
+    <directive module="mod_auth_basic">AuthBasicProvider</directive> or \r
+    <directive module="mod_auth_digest">AuthDigestProvider</directive> in\r
+    the same way as a base authentication provider.  Besides the ability\r
+    to create and alias an extended provider, it also allows the same \r
+    extended authentication provider to be reference by multiple \r
+    locations.</p>\r
+\r
+</summary>\r
+\r
+<section id="example"><title>Example</title>\r
+    <p>The example below creates two different ldap authentication \r
+    provider aliases based on the ldap provider.  This allows\r
+    a single authenticated location can be serviced by multiple \r
+    ldap hosts:</p>\r
+\r
+    <example><title>Example</title>\r
+      LoadModule authn_alias_module modules/mod_authn_alias.so<br /><br />\r
+      &lt;AuthnProviderAlias ldap ldap-alias1&gt;<br />\r
+      <indent>\r
+         AuthLDAPBindDN cn=youruser,o=ctx<br />\r
+         AuthLDAPBindPassword yourpassword<br />\r
+         AuthLDAPURL ldap://ldap.host/o=ctx<br />\r
+      </indent>\r
+      &lt;/AuthnProviderAlias&gt;<br /><br />\r
+      &lt;AuthnProviderAlias ldap ldap-other-alias&gt;<br />\r
+      <indent>\r
+         AuthLDAPBindDN cn=yourotheruser,o=dev<br />\r
+         AuthLDAPBindPassword yourotherpassword<br />\r
+         AuthLDAPURL ldap://other.ldap.host/o=dev?cn<br />\r
+      </indent>\r
+      &lt;/AuthnProviderAlias&gt;<br /><br />\r
+\r
+      Alias /secure /webpages/secure<br />\r
+      &lt;Directory /webpages/secure&gt;<br />\r
+      <indent>\r
+         Order deny,allow<br />\r
+         Allow from all<br /><br />\r
+    \r
+         AuthBasicProvider ldap-other-alias  ldap-alias1<br /><br />\r
+    \r
+         AuthType Basic<br />\r
+         AuthName LDAP_Protected_Place<br />\r
+         AuthzLDAPAuthoritative off<br />\r
+         require valid-user<br />\r
+      </indent>\r
+      &lt;/Directory&gt;<br />\r
+    </example>\r
+</section>\r
+\r
+<directivesynopsis type="section">\r
+<name>AuthnProviderAlias</name>\r
+<description>Enclose a group of directives that represent an\r
+extension of a base authentication provider and referenced by\r
+the specified alias</description>\r
+<syntax>&lt;AuthnProviderAlias <var>baseProvider Alias</var>&gt;\r
+... &lt;/AuthnProviderAlias&gt;</syntax>\r
+<contextlist><context>server config</context><context>virtual host</context>\r
+</contextlist>\r
+\r
+<usage>\r
+    <p><directive type="section">AuthnProviderAlias</directive> and\r
+    <code>&lt;/AuthnProviderAlias&gt;</code> are used to enclose a group of\r
+    authentication directives that can be referenced by the alias name \r
+    using one of the directives <directive module="mod_auth_basic">\r
+    AuthBasicProvider</directive> or <directive module="mod_auth_digest">\r
+    AuthDigestProvider</directive>.</p>\r
+\r
+</usage>\r
+</directivesynopsis>\r
+\r
+</modulesynopsis>\r

diff --git a/docs/manual/mod/mod_authn_alias.xml.meta b/docs/manual/mod/mod_authn_alias.xml.meta
new file mode 100644 (file)
index 0000000..3709020
--- /dev/null
+++ b/docs/manual/mod/mod_authn_alias.xml.meta
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>\r
+\r
+<metafile>\r
+  <basename>mod_authn_alias</basename>\r
+  <path>/mod/</path>\r
+  <relpath>..</relpath>\r
+\r
+  <variants>\r
+    <variant>en</variant>\r
+  </variants>\r
+</metafile>\r