mod-auth-commit

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

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

Added Files:
	index.xml index.xml.meta 
Log Message:
add docs for mod_authn_cache


--- 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_cache</name>
<description>User authentication Caching</description>
<status>External</status>
<sourcefile>mod_authn_cache.c</sourcefile>
<identifier>authn_cache</identifier>
<compatibility>Apache 2.1 or greater</compatibility>

  <summary>
    <p>      
      The module <code>mod_authn_cache</code> caches authentication information generated from other modules
    </p>
  </summary>
  
  <section id="compilation">
    <title>Compilation</title>
    <p>
      <code>mod_authn_cache</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_cache</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>
    </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_cache</code> behave like your average next-door
      Apache module. Just add<br /><br />
      <code>LoadModule authn_cache_module   modules/mod_authn_cache.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_cache</title>
<p><b>Draft...</b></p>
<p>
    <example>
      <title>Example Config</title>
      <pre>
       &lt;Location /secure-area&gt;
         AuthType Basic
         AuthName  "basic authn_cache testing area"
         AuthBasicProvider cache
         AuthnCacheProvider file
         AuthnCacheType shmht:logs/authn_cache.shm(10000)
         AuthUserFile .htpasswd
         Require valid-user
       &lt;/Location&gt;
      </pre>
    </example>
</p>
</section>

  <directivesynopsis>
    <name>AuthnCacheProvider</name>
    <description>Name of the Authentication Provider</description>
    <syntax>AuthnCacheProvider <var>AuthnProvider</var></syntax>
    <default>none</default>
    <contextlist>
      <context>.htaccess</context>
    </contextlist>
    <usage>
      <p>
      </p>
    </usage>
  </directivesynopsis>

  <directivesynopsis>
    <name>AuthnCacheType</name>
    <description>Type of Global Cache</description>
    <syntax>AuthnCacheType <var>shmht:file(size)</var></syntax>
    <default>none</default>
    <contextlist>
      <context>.htaccess</context>
    </contextlist>
    <usage>
      <p>
      </p>
    </usage>
  </directivesynopsis>

</modulesynopsis>

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

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

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