[Mod-auth-commit] mod_auth_webspace/htdocs/docs/mod_authn_pam index.xml,NONE,1.1 index.xml.meta,NONE,1.1

[<fir...@us...>]

Update of /cvsroot/mod-auth/mod_auth_webspace/htdocs/docs/mod_authn_pam
In directory sc8-pr-cvs1:/tmp/cvs-serv10136/mod_auth_webspace/htdocs/docs/mod_authn_pam

Added Files:
	index.xml index.xml.meta 
Log Message:
adding docs for authn_pam and fixed a typo in authn_pop3 docs


--- NEW FILE: index.xml ---
<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../../style/manual.en.xsl"?>

<modulesynopsis metafile="index.xml.meta">

<name>mod_authn_pam</name>
<description>User authentication using PAM</description>
<status>External</status>
<sourcefile>mod_authn_pam.c</sourcefile>
<identifier>authn_pam</identifier>
<compatibility>Apache 2.1 or greater</compatibility>

  <summary>
    <p>      
      The module <code>mod_authn_pam</code> provides Authentication against a
      PAM framework using cleartext passwords. 
    </p>
  </summary>
  
  <section id="compilation">
    <title>Compilation</title>
    <p>
      <code>mod_authn_pam</code> uses the "<code>configure/make/make install</code>"
      mechanism 
      common to many Open Source programs.
      Most of the dirty work is handled by either configure or 
      Apache's apxs utility. If you have built apache modules before, there
      shouldn't be any surprises for you.
    </p>
    <p>
      Before you can begin compiling <code>mod_authn_pam</code>, you will need a
      working installation of Apache 2.1-dev (any earlier version,
      including Apache 2.0.x will NOT work).
    </p>
    <p>
      The interesting options you can pass to configure are:
    <ul>
      <li><code>--with-apxs=/path/to/apache/dir/bin/apxs</code>
	<p>
	  This option is used to specify the location of the
	  apxs utility that was installed as part of apache.
	  Specify the location of the binary, not the directory
	  it is located in.
	</p>
      </li>
      <li><code>--with-pam=/path/to/libpam</code>
	<p>
	</p>
      </li>
      <li><code>--with-pam-includes=/path/to/libpam/includes</code>
	<p>
	</p>
      </li>
      <li><code>--with-pam-libs=/path/to/libpam/lib</code>
	<p>
	</p>
      </li>
    </ul>
  </p>
    <p>
      Call configure with your site-specific values and then
      "make" and "make install" as usual. The module will be installed
      in the module directory of your Apache installation.
    </p>
  </section>

  <section id="integration">
    <title>Integration into Apache</title>
    <p>Again <code>mod_authn_pam</code> behave like your average next-door
      Apache module. Just add<br /><br />
      <code>LoadModule authn_pam_module   modules/mod_authn_pam.so</code><br
	/><br />
      to your <code>httpd.conf</code> as usual and restart Apache.
</p>

</section>
<section id="basic">
<title>Basic configuration of mod_authn_pam</title>
<p><b>Draft...</b></p>
<p>
    <example>
      <title>Example Config</title>
      <pre>
       &lt;Location /secure-area&gt;
         AuthType Basic
         AuthName  "basic authn_pop3 testing area"
         AuthBasicProvider pam
         Require valid-user
       &lt;/Location&gt;
      </pre>
    </example>
</p>
</section>

  <directivesynopsis>
    <name>AuthnPAMFailDelay</name>
    <description>Time to delay on failed authentication</description>
    <syntax>AuthnPAMFailDelay <var>time</var></syntax>
    <default>none</default>
    <contextlist>
      <context>.htaccess</context>
    </contextlist>
    <usage>
      <p>Requires Support from the Operating System PAM Lib.
      </p>
    </usage>
  </directivesynopsis>

</modulesynopsis>

--- NEW FILE: index.xml.meta ---
<?xml version="1.0" encoding="UTF-8" ?>

<metafile>
  <basename>mod_authn_pam</basename>
  <path>../</path>
  <relpath>../../</relpath>

  <variants>
    <variant>en</variant>
  </variants>
</metafile>