[Mod-auth-commit] mod_auth_webspace/htdocs/docs/mod_authn_dbi index.xml,1.7,1.8

[<ho...@us...>]

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

Modified Files:
	index.xml 
Log Message:
a few lines more docs


Index: index.xml
===================================================================
RCS file: /cvsroot/mod-auth/mod_auth_webspace/htdocs/docs/mod_authn_dbi/index.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** index.xml	11 Nov 2003 00:03:02 -0000	1.7
--- index.xml	24 Nov 2003 23:15:22 -0000	1.8
***************
*** 109,119 ****
  </p>
  
! </section>
! <section id="db">
! <title>Preparing the Database</title>
!     <p><b>Draft....</b></p>
! 
      <p>
!       Of course, before you can use mod_authn_dbi, you will need to
        decide which database to use and create it if it does
        not already exists. mod_authn_dbi is pretty flexible and
--- 109,177 ----
  </p>
  
!   </section>
!   <section id="overview">
!     <title>An overview of mod_authn_dbi</title>
!     <p><b>in progress....</b></p>
!   <p>
!       The configuration of <code>mod_authn_dbi</code> consists of two main
!       parts. First, you configure one or more configuration sets. Second, you use
!       these configuration sets in any number of basic or digest authentication realms.
!     </p>
      <p>
!       <h3>Configuration sets</h3>
!       Most configuration directives of <code>mod_authn_dbi</code> are of the
!       format<br /><br />
!       <code>DirectiveName &lt;name&gt; &lt;value&gt;</code>
!       <br /><br />
!       Configuration sets are implicitely created each time you specify a
!       <code>&lt;name&gt;</code> that has not been used before. All directives that are not
!       specified for a given configuration set remain at their default
!       values. So the minimum to create a usable configuration set is just one
!       of the directives.<br />
!       Configuration sets contain all the information needed to connect to the
!       database server, choose the correct database and table and extract the
!       values needed for authenticating users. Additionally, you can specify
!       options that for example influence the pooling of connections (see below)
!       or the way that the data in the table is interpreted.
!       
!     <example>
!       <title>An example configuration set</title>
!       <pre>
! 	AuthnDbiDriver         Server1  mysql
! 	AuthnDbiHost           Server1  mycoolcatserver.com
! 	AuthnDbiUsername       Server1  MyUser
! 	AuthnDbiPassword       Server1  MyPass
! 	AuthnDbiName           Server1  MyDatabaseName
! 	AuthnDbiTable          Server1  MyDatabaseTable
! 	AuthnDbiUsernameField  Server1  theUserNameField
! 	AuthnDbiPasswordField  Server1  PasswordField
! 	AuthnDbiIsActiveField  Server1  IsActiveField
! 	AuthnDbiConnMin        Server1    3
! 	AuthnDbiConnSoftMax    Server1   12
! 	AuthnDbiConnHardMax    Server1   20
! 	AuthnDbiConnTTL        Server1  600
!       </pre>
!     </example>
!   </p>
!     <p>
!       <h3>Authentication realms</h3>
!     <example>
!       <title>An example authentication realm</title>
!       <pre>
! 	&lt;Directory "/path/to/htdocs/to/be/area_1_protected"&gt;
! 	  AuthType              Basic
! 	  AuthName              "basic authn_dbi testing area"
! 	  AuthBasicProvider     dbi
! 	  AuthnDbiServerConfig  Server1
! 	  Require               valid-user
! 	&lt;/Directory&gt;
!       </pre>
!     </example>
!   </p>
!   </section>
!   <section id="db">
!     <title>Preparing the Database</title>
!     <p>
!       Of course, before you can use <code>mod_authn_dbi</code>, you will need to
        decide which database to use and create it if it does
        not already exists. mod_authn_dbi is pretty flexible and
***************
*** 131,139 ****
        these requirements will change or go away.
      </p>
      <p>
!       The default structure that mod_authn_dbi expects is a database
!       called "AuthDB", which contains a table called "Users".
!       In this table, it expects two string (VARCHAR or similar) columns
!       "Username" and "Password" containing the usernames and for each of them
        the password in plaintext.
      </p>
--- 189,198 ----
        these requirements will change or go away.
      </p>
+     <h4>Starting from scratch...</h4><br />
      <p>
!       The default structure that <code>mod_authn_dbi</code> expects is a database
!       called "<code>AuthDB</code>", which contains a table called "<code>Users</code>".
!       In this table, it expects two string (<code>VARCHAR</code> or similar) columns
!       "<code>Username</code>" and "<code>Password</code>" containing the usernames and for each of them
        the password in plaintext.
      </p>
***************
*** 149,156 ****
        <code>CREATE table Users (Username VARCHAR(32), Password VARCHAR(32));</code>
      </p>
      <p>
        In the first step of customization, you can change the values for 
        driver, host, user, password, database, table, column names and
! the password format. 
  </p><p>
  So, let's continue with...
--- 208,216 ----
        <code>CREATE table Users (Username VARCHAR(32), Password VARCHAR(32));</code>
      </p>
+ 
      <p>
        In the first step of customization, you can change the values for 
        driver, host, user, password, database, table, column names and
! the password format to match a table in an existing database.
  </p><p>
  So, let's continue with...
***************
*** 181,204 ****
  the table "MyDatabaseTable" instead of the default "AuthDB",
  you get the idea...
- </p><p>
-     <example>
-       <title>Example Config</title>
-       <pre>
- 	AuthnDbiDriver Server1 mysql
- 	AuthnDbiHost Server1 mycoolcatserver.com
- 	AuthnDbiUsername Server1 MyUser
- 	AuthnDbiPassword Server1 MyPass
- 	AuthnDbiName Server1 MyDatabaseName
- 	AuthnDbiTable Server1 MyDatabaseTable
- 	AuthnDbiUsernameField Server1 theUserNameField
- 	AuthnDbiPasswordField Server1 PasswordField
- 	AuthnDbiIsActiveField Server1 IsActiveField
- 	
- 	AuthnDbiConnMin Server1 3
- 	AuthnDbiConnSoftMax Server1 12
- 	AuthnDbiConnHardMax Server1 20
- 	AuthnDbiConnTTL Server1 600
-       </pre>
-     </example>
  </p>
  </section>
--- 241,244 ----
***************
*** 211,214 ****
--- 251,261 ----
  </section>
  
+ <section id="pooling">
+ <title>Pooling of database connections</title>
+     <p>
+       coming soon...
+     </p>
+ </section>
+ 
    <directivesynopsis>
      <name>AuthnDbiDriver</name>
***************
*** 645,649 ****
  	    given, all accounts that have "<code>::</code>" as password value
  	    will be accepted with <em>any</em> password that the user
! 	    supplies. With this options, you can for example implement guest-accounts.</td></tr>
        </table>
        </p>
--- 692,699 ----
  	    given, all accounts that have "<code>::</code>" as password value
  	    will be accepted with <em>any</em> password that the user
! 	    supplies. With this options, you can for example implement
! 	    guest-accounts. (The name of this option does not really fit its
! 	    behaviour, but somehow i could not think of a better name when
! 	    implementing it.)</td></tr>
        </table>
        </p>