X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=cgi-auth-flexible.git;a=blobdiff_plain;f=caf.pod;h=4277923aa9603f782c7a643aaa358d3d9cccdbe6;hp=2088fe569cba9fbcdd0b3b6f6f7f9d985db0621f;hb=52e25ce84bfd2d237e5a51dd4637da51104fa26c;hpb=03f2ca2687a0585c029dbfe859df35c374b538cc diff --git a/caf.pod b/caf.pod index 2088fe5..4277923 100644 --- a/caf.pod +++ b/caf.pod @@ -618,8 +618,8 @@ any tags. =item C -The secret cookie which should be set along with whatever response is -sent to the client. The value in the hash is the actual secret value +The login cookie which should be set along with whatever response is +sent to the client. The value in the hash is the actual value of the cookie as a string. C means no cookie setting header should be sent; C<''> means the cookie should be cleared. @@ -752,7 +752,7 @@ path settings are relative values. Must be an absolute filename. -=item C +=item C CGI::Auth::Flexible needs a database for recording users' login session. This database needs to be shared across all instances of the @@ -766,26 +766,26 @@ particular, there is no need for transactional integrity across changes made by CAF and your own application.) By default, CAF uses a sqlite3 database stored on local disk in the -file named by C. This will be suitable for all +file named by C. This will be suitable for all applications which run on a single host. This value, if supplied, should be a DBI handle for the database. -=item C +=item C This is the DSN to pass to C<< DBI->connect >>. Used only if -C is not supplied. +C is not supplied. -=item C +=item C Path to the sqlite3 database used for CAF's session storage. The -default is currently C but will change in the future. +default is C. -Used only if neither C or C are supplied. +Used only if neither C or C are supplied. If this is a relative path, it is in C. -=item C +=item C Prefix for the SQL tables and indices to use (and to create, if necessary). @@ -1320,7 +1320,7 @@ 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 +modify the default setup statements, via the C setting. The tables needed are: @@ -1331,7 +1331,7 @@ xxx make _db_setup_do explicitly overrideable xxx remaining settings - assocdb_password + db_password username_password_error login_ok get_cookie_domain @@ -1347,7 +1347,5 @@ 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