[interchange-docs] xmldocs - racke modified glossary/UserDB

[docs at icdevgroup.org]

User:      racke
Date:      2006-08-10 09:42:05 GMT
Modified:  glossary UserDB
Log:
added table with UserDB options

Revision  Changes    Path
1.3       +81 -0     xmldocs/glossary/UserDB


rev 1.3, prev_rev 1.2
Index: UserDB
===================================================================
RCS file: /var/cvs/xmldocs/glossary/UserDB,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- UserDB	15 Dec 2004 14:24:00 -0000	1.2
+++ UserDB	10 Aug 2006 09:42:05 -0000	1.3
@@ -0,0 +1,81 @@
+
+<table>
+<title>UserDb Options</title>
+<tgroup cols="3">
+<thead>
+<row><entry>Parameter</entry><entry>Explanation</entry><entry>Default</entry></row>
+</thead>
+<tbody>
+<row><entry>acl</entry><entry>Set field name for simple access control storage.</entry><entry>acl</entry></row>
+<row><entry>addr_field</entry><entry>Set field name for the address book.
+</entry><entry>address_book</entry></row>
+<row><entry>assign_username</entry><entry>Tell interchange to automatically assign username if not provided.
+</entry><entry>0</entry></row>
+<row><entry>bill_field</entry><entry>Set field name for accounts.
+</entry><entry>accounts</entry></row>
+<row><entry>captcha</entry><entry>
+</entry><entry></entry></row>
+<row><entry>cart_field</entry><entry>Set field name for cart storage.
+</entry><entry>carts</entry></row>
+<row><entry>clear_cookie</entry><entry>List of cookies to clear on explicit logout.
+</entry><entry></entry></row>
+<row><entry>clear_session</entry><entry>Clear user session completely upon logout.
+</entry><entry></entry></row>
+<row><entry>counter</entry><entry>Counter file for assign_username function.
+</entry><entry></entry></row>
+<row><entry>crypt</entry><entry>Whether to encrypt passwords.
+</entry><entry>1</entry></row>
+<row><entry>database</entry><entry>Selects table for user database.
+</entry><entry>userdb</entry></row>
+<row><entry>db_acl</entry><entry>Set field name for database access control storage.
+</entry><entry>db_acl</entry></row>
+<row><entry>expire_field</entry><entry>Set field name for account's expiration date.
+</entry><entry>expiration</entry></row>
+<row><entry>file_acl</entry><entry>Set field name for file access control storage.
+</entry><entry>file_acl</entry></row>
+<row><entry>force_lower</entry><entry>Force possibly upper-case database fields to lower case session variable names.
+</entry><entry>0</entry></row>
+<row><entry>ignore_case</entry><entry>Ignore case in usernames/passwords.
+</entry><entry>0</entry></row>
+<row><entry>indirect_login</entry><entry>Set the field name used as login field if different from the key field.
+</entry><entry></entry></row>
+<row><entry>logfile</entry><entry>File to which successful and unsuccessful authentication messages should be sent.
+</entry><entry>error.log</entry></row>
+<row><entry>md5</entry><entry>Use MD5 for encryption algorithm instead of crypt.
+</entry><entry>0</entry></row>
+<row><entry>no_get</entry><entry>Don't get values from database on login.
+</entry><entry>0</entry></row>
+<row><entry>no_login</entry><entry>Log people in to accounts even if they are already logged in.
+</entry><entry>0</entry></row>
+<row><entry>outboard_key_col</entry><entry>Set field providing key for outboard tables
+</entry><entry></entry></row>
+<row><entry>outboard</entry><entry>Set fields that live in another table
+</entry><entry></entry></row>
+<row><entry>pass_field</entry><entry>Set field name for password.
+</entry><entry>password</entry></row>
+<row><entry>passminlen</entry><entry>Minimum length for password.
+</entry><entry>2</entry></row>
+<row><entry>postlogin_action</entry><entry>
+</entry><entry></entry></row>
+<row><entry>pref_field</entry><entry>Set field name for preferences.
+</entry><entry>preferences</entry></row>
+<row><entry>scratch</entry><entry>Fields to set in user Scratch space (instead of Values).
+</entry><entry></entry></row>
+<row><entry>sql_counter</entry><entry>SQL counter spec (sequence or AUTO_INCREMENT) for assign_username function.
+</entry><entry></entry></row>
+<row><entry>super_field</entry><entry>Field to determine superuser status if admin profile.
+</entry><entry>super</entry></row>
+<row><entry>time_field</entry><entry>Set field for storing last login time.
+</entry><entry>time</entry></row>
+<row><entry>unix_time</entry><entry>Set if unix (seconds since 1970) time to go in log files.
+</entry><entry>0</entry></row>
+<row><entry>userminlen</entry><entry>Minimum length for username.
+</entry><entry>2</entry></row>
+<row><entry>username_email</entry><entry>
+</entry><entry></entry></row>
+<row><entry>username_mask</entry><entry>Regular expression usernames must not match.
+</entry><entry></entry></row>
+<row><entry>validchars</entry><entry>Set valid characters for usernames.</entry><entry></entry></row>
+</tbody>
+</tgroup>
+</table>
\ No newline at end of file