Commit cbcc141c authored by Nick Kew's avatar Nick Kew
Browse files

Add a usage example to documentation page 


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

docs/manual/mod/mod_authn_dbd.html.en

+54 −14
Changes for docs/manual/mod/mod_authn_dbd.html.en: 54 added lines, 14 removed lines.
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="ISO-8859-1"?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><!--

        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

              This file is generated from xml source: DO NOT EDIT

        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

      -->

<title>mod_authn_dbd - Apache HTTP Server</title>

<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />

<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />

<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />

<link href="../images/favicon.ico" rel="shortcut icon" /></head>

<link title="Main stylesheet" type="text/css" media="all" rel="stylesheet" href="../style/css/manual.css" />

<link title="No Sidebar - Default font size" type="text/css" media="all" rel="alternate stylesheet" href="../style/css/manual-loose-100pc.css" />

<link type="text/css" media="print" rel="stylesheet" href="../style/css/manual-print.css" />

<link rel="shortcut icon" href="../images/favicon.ico" /></head>

<body>

<div id="page-header">

<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>

<p class="apache">Apache HTTP Server Version 2.1</p>

<img alt="" src="../images/feather.gif" /></div>

<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>

<img src="../images/feather.gif" alt="" /></div>

<div class="up"><a href="./"><img src="../images/left.gif" alt="&lt;-" title="&lt;-" /></a></div>

<div id="path">

<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div>

<div id="page-content">
@@ -47,10 +47,13 @@ 
</div>

<div id="quickview"><h3 class="directives">Directives</h3>

<ul id="toc">

<li><img alt="" src="../images/down.gif" /> <a href="#authdbduserpwquery">AuthDBDUserPWQuery</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#authdbduserrealmquery">AuthDBDUserRealmQuery</a></li>

<li><img src="../images/down.gif" alt="" /> <a href="#authdbduserpwquery">AuthDBDUserPWQuery</a></li>

<li><img src="../images/down.gif" alt="" /> <a href="#authdbduserrealmquery">AuthDBDUserRealmQuery</a></li>

</ul>

<h3>See also</h3>

<h3>Topics</h3>

<ul id="topics">

<li><img src="../images/down.gif" alt="" /> <a href="#example">Configuration Example</a></li>

</ul><h3>See also</h3>

<ul class="seealso">

<li><code class="directive"><a href="../mod/core.html#authname">AuthName</a></code></li>

<li><code class="directive"><a href="../mod/core.html#authtype">AuthType</a></code></li>
@@ -63,9 +66,46 @@ 
<li><code class="directive"><a href="../mod/mod_dbd.html#dbdriver">DBDriver</a></code></li>

<li><code class="directive"><a href="../mod/mod_dbd.html#dbdparams">DBDParams</a></code></li>

</ul></div>

<div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div>

<div class="section">

<h2><a id="example" name="example">Configuration Example</a></h2>



<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

<div class="directive-section"><h2><a name="AuthDBDUserPWQuery" id="AuthDBDUserPWQuery">AuthDBDUserPWQuery</a> <a name="authdbduserpwquery" id="authdbduserpwquery">Directive</a></h2>

<p>This simple example shows use of this module in the context of

the Authentication and DBD frameworks.</p>

<div class="example"><pre>

#Database Management



#Use the PostgreSQL driver

<code>DBDriver pgsql</code>



#Connection string: database name and login credentials

<code>DBDParams "dbname=htpasswd user=apache pass=xxxxxx"</code>



#Parameters for Connection Pool Management

<code>DBDMin  1

DBDKeep 2

DBDMax  10

DBDExptime 60</code>



#Authentication Section

<code>&lt;Directory /usr/www/myhost/private&gt;</code>



    #mod_auth configuration for authn_dbd

    <code>AuthType Basic

    AuthName "My Server"

    AuthBasicProvider dbd</code>



    #authz configuration

    <code>Require valid-user</code>



    #SQL query to verify a user

    #(note: DBD drivers recognise both stdio-like %s and native syntax)

    <code>AuthDBDUserPWQuery "select password from authn where username = %s"

&lt;/Directory&gt;</code>

</pre></div>

</div>

<div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div>

<div class="directive-section"><h2><a id="AuthDBDUserPWQuery" name="AuthDBDUserPWQuery">AuthDBDUserPWQuery</a> <a id="authdbduserpwquery" name="authdbduserpwquery">Directive</a></h2>

<table class="directive">

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SQL query to look up a password for a user</td></tr>

<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBDUserPWQuery <var>query</var></code></td></tr>
@@ -85,8 +125,8 @@ 




</div>

<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

<div class="directive-section"><h2><a name="AuthDBDUserRealmQuery" id="AuthDBDUserRealmQuery">AuthDBDUserRealmQuery</a> <a name="authdbduserrealmquery" id="authdbduserrealmquery">Directive</a></h2>

<div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div>

<div class="directive-section"><h2><a id="AuthDBDUserRealmQuery" name="AuthDBDUserRealmQuery">AuthDBDUserRealmQuery</a> <a id="authdbduserrealmquery" name="authdbduserrealmquery">Directive</a></h2>

<table class="directive">

<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SQL query to look up a password hash for a user and realm.

</td></tr>

docs/manual/mod/mod_authn_dbd.xml

+38 −0
Changes for docs/manual/mod/mod_authn_dbd.xml: 38 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -57,6 +57,44 @@ 
<seealso><directive module="mod_dbd">DBDriver</directive></seealso>

<seealso><directive module="mod_dbd">DBDParams</directive></seealso>



<section id="example">

<title>Configuration Example</title>

<p>This simple example shows use of this module in the context of

the Authentication and DBD frameworks.</p>

<example><pre>

#Database Management



#Use the PostgreSQL driver

<code>DBDriver pgsql</code>



#Connection string: database name and login credentials

<code>DBDParams "dbname=htpasswd user=apache pass=xxxxxx"</code>



#Parameters for Connection Pool Management

<code>DBDMin  1

DBDKeep 2

DBDMax  10

DBDExptime 60</code>



#Authentication Section

<code>&lt;Directory /usr/www/myhost/private&gt;</code>



    #mod_auth configuration for authn_dbd

    <code>AuthType Basic

    AuthName "My Server"

    AuthBasicProvider dbd</code>



    #authz configuration

    <code>Require valid-user</code>



    #SQL query to verify a user

    #(note: DBD drivers recognise both stdio-like %s and native syntax)

    <code>AuthDBDUserPWQuery "select password from authn where username = %s"

&lt;/Directory&gt;</code>

</pre>

</example>

</section>



<directivesynopsis>

<name>AuthDBDUserPWQuery</name>

<description>SQL query to look up a password for a user</description>