From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Wed, 3 Apr 2013 20:52:22 +0000 (+0100)
Subject: docs: more work
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=cgi-auth-flexible.git;a=commitdiff_plain;h=03f2ca2687a0585c029dbfe859df35c374b538cc

docs: more work
---

diff --git a/caf.pod b/caf.pod
index 8ed5d51..2088fe5 100644
--- a/caf.pod
+++ b/caf.pod
@@ -1311,6 +1311,21 @@ your application runs on multiple frontend hosts with a shared
 database, you may need to create for yourself the tables and indices
 used by CGI::Auth::Flexible.
 
+By default, every time CAF starts up, it attempts to execute certain
+fixed database statements to create the tables and indices it needs.
+These are run with C<$dbh->{PrintError}> set to 0.  The effect with
+sqlite (the default database) is that the tables and indices are
+created iff they do not already exist, and that no spurious errors are
+reported anywhere.
+
+If you use a different database, or just prefer to do things
+differently, you can set up the tables yourself and/or disable or
+modify the default setup statements, via the C<assocdb_setup_stmts>
+setting.
+
+The tables needed are:
+
+
 xxx document _db_setup_do
 xxx make _db_setup_do explicitly overrideable
 
@@ -1327,9 +1342,12 @@ xxx remaining settings
 xxx document cookie usage
 xxx document construct_cookie fn
 
+xxx document @default_db_setup_statements
+
 xxx bugs wrong default random on Linux
 xxx bugs wrong default random on *BSD
 xxx bugs keys not shared should be in db
 xxx rename caf-assocs.db
 xxx rename caf_assocsecret default cookie name
 xxx mention relationship between login_timeout and cookies
+xxx rename assocdb settings to db