[docs] docs - heins modified 2 files
docs at icdevgroup.org
docs at icdevgroup.org
Sun Jul 6 21:30:00 EDT 2003
User: heins
Date: 2003-07-07 00:30:44 GMT
Modified: . icdatabase.sdf icconfig.sdf
Log:
* Document md5 parameter, add some documentation for UserDB config
directive.
Revision Changes Path
1.54 +56 -32 docs/icdatabase.sdf
rev 1.54, prev_rev 1.53
Index: icdatabase.sdf
===================================================================
RCS file: /anon_cvs/repository/docs/icdatabase.sdf,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -r1.53 -r1.54
--- icdatabase.sdf 30 Oct 2002 17:24:00 -0000 1.53
+++ icdatabase.sdf 7 Jul 2003 00:30:44 -0000 1.54
@@ -1,10 +1,10 @@
!init OPT_LOOK="icdevgroup"; OPT_STYLE="manual"
-# $Id: icdatabase.sdf,v 1.53 2002/10/30 17:24:00 mheins Exp $
+# $Id: icdatabase.sdf,v 1.54 2003/07/07 00:30:44 mheins Exp $
!define DOC_NAME "Interchange Databases"
!define DOC_TYPE ""
!define DOC_CODE "icdatabase"
-!define DOC_VERSION substr('$Revision: 1.53 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.54 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://www.icdevgroup.org/doc/icdatabase.html"
@@ -12,22 +12,38 @@
H1: Databases and Interchange
-Interchange can use GDBM, DB_File, SQL, LDAP, or in-memory databases. In most cases, these different database formats should operate the same when called by Interchange's access methods.
+Interchange is database-independent, perhaps more so than almost
+any other powerful content management system.
-Also, Interchange does not require an external SQL database. If you have
-a small database and do not want to integrate your own tool set, you
-might want to use Interchange's internal database. However, the order
+Interchange can use GDBM, DB_File, SQL, LDAP, or in-memory databases. In
+most cases, these different database formats should operate the same
+when called by Interchange's access methods.
+
+Also, most all of Interchange's core functions do not use hard-coded
+field names; virtually every field can have a configurable name.
+
+Interchange does not require an external SQL database. If you have
+a small data set and do not want to integrate your own tool set, you
+cound use Interchange's internal database. However, the order
management functions of Interchange will be slower and not as robust
without an SQL database. SQL is strongly recommended for at least the
-orderline, transactions, and userdb tables.
+orderline, transactions, and userdb tables.
-Keeping a database in an SQL manager makes it easier to integrate Interchange with other tools. Interchange can be used to maintain a spreadsheet containing product information through modifying the file C<products.txt> as needed. References to SQL, DBI, and DBD can be ignored.
+Keeping a database in an SQL manager makes it easier to integrate
+Interchange with other tools. Interchange can be used to maintain a
+spreadsheet containing product information through modifying the
+file C<products.txt> as needed. References to SQL, DBI, and DBD can
+be ignored.
H2: Text Source Files
-Interchange reads delimited text files to obtain data. However, the text files are not the database. They are the source information for the database tables.
-
-By default, all database source files are located in the C<products> subdirectory of the catalog directory. The main products database is in the C<products/products.txt> file in the supplied demo catalog.
+Interchange reads delimited text files to obtain its initial data.
+However, the text files are not the database. They are the source
+information for the database tables.
+
+By default, all database source files are located in the C<products>
+subdirectory of the catalog directory. The main products database is in
+the C<products/products.txt> file in the supplied demo catalog.
Note:If you are using one of the internal database methods, any changes made to the ASCII source file will be reflected in the database in the next user session. If the product database contains less than a thousand records, updates will be instantaneous. If the product database is larger, updates will take longer. Use the C<NoImport> reference tag to stop auto updating.
@@ -200,6 +216,7 @@
Type 6 TAB
Type 7 reserved
Type 8 SQL
+ Type 9 LDAP
!endblock
The databases are specified in C<Database> directives, as:
@@ -558,7 +575,9 @@
H2: Exporting from a Database
-To export an existing database to a file suitable for searching by Interchange, create a page that contains a C<[tag export ...][/tag]> element. Perhaps a better method is to define the same sort of tags in an OrderProfile, and use forms and buttons to access the profile.
+To export an existing database to a file to its text file, suitable for
+full-text search by Interchange, use Interchange's UI create a page that contains a
+C<[export table=TABLENAME]> ITL tag (ExportTag).
H2: Write Control
@@ -1506,25 +1525,25 @@
field for a search match. These operations are supported:
!block example
- != Not equal to
- !~ Not matching regular expression
- < Less than
- <= Less than or equal to
- <> Not equal to
- = Equal to
- == Equal to
- =~ Matching regular expression
- > Greater than
- >= Greater than or equal to
- em Exact match
- eq Equal to
- ge Greater than or equal to
- gt Greater than
- le Less than or equal to
- lt Less than
- ne Not equal to
- rm Matching regular expression
- rn Not matching regular expression
+ != Not equal to
+ !~ Not matching regular expression
+ < Less than
+ <= Less than or equal to
+ <> Not equal to
+ = Equal to
+ == Equal to
+ =~ Matching regular expression
+ > Greater than
+ >= Greater than or equal to
+ em Exact match
+ eq Equal to
+ ge Greater than or equal to
+ gt Greater than
+ le Less than or equal to
+ lt Less than
+ ne Not equal to
+ rm Matching regular expression
+ rn Not matching regular expression
!endblock
.If stacked to match the C<mv_search_field> and C<mv_searchspec> variables, and C<mv_coordinate> is set, it will operate only for the corresponding field.
@@ -2854,6 +2873,11 @@
Encryption can still be set on by passing C<crypt=1> with any call to a C<new_account>, C<change_pass>, or C<login> call.
+If you are encrypting, and you wish to use MD5 to encrypt the passwords, set
+the C<md5> parameter:
+
+ UserDB default md5 1
+
H2: Setting Defaults with the UserDB Directive
The C<UserDB> directive provides a way to set defaults for the user database. For example, to save and recall the scratch variable C<tickets> in the user database
@@ -2917,7 +2941,7 @@
LI1: login
-.Active parameters: username, password, crypt, pass_field, ignore_case, indirect_login
+.Active parameters: username, password, crypt, md5, pass_field, ignore_case, indirect_login
.Log in to Interchange. By default, the username is contained in the form
variable C<mv_username> and the password in C<mv_password>. If the login
1.79 +58 -2 docs/icconfig.sdf
rev 1.79, prev_rev 1.78
Index: icconfig.sdf
===================================================================
RCS file: /anon_cvs/repository/docs/icconfig.sdf,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -r1.78 -r1.79
--- icconfig.sdf 14 Dec 2002 18:01:11 -0000 1.78
+++ icconfig.sdf 7 Jul 2003 00:30:44 -0000 1.79
@@ -1,10 +1,10 @@
!init OPT_LOOK="icdevgroup"; OPT_STYLE="manual"
-# $Id: icconfig.sdf,v 1.78 2002/12/14 18:01:11 jon Exp $
+# $Id: icconfig.sdf,v 1.79 2003/07/07 00:30:44 mheins Exp $
!define DOC_NAME "Configuration Reference"
!define DOC_TYPE ""
!define DOC_CODE "icconfig"
-!define DOC_VERSION substr('$Revision: 1.78 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.79 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://www.icdevgroup.org/doc/icconfig.html"
@@ -2747,6 +2747,62 @@
quantity
item
!endblock
+
+H2: UserDB
+
+Sets parameters to define the behavior of Interchange's user database functions.
+
+!block table
+Parameter|Default|Explanation
+acl|acl|Set field for simple access control storage
+addr_field|address_book|Set field name for address book
+assign_username|0|Tell interchange to automatically assign username
+bill_field|accounts|Set field name for accounts
+cart_field|carts|Set field name for cart storage
+clear_coookie||Comma-separated list of cookies to clear on explicit logout
+clear_session||Clear user session completely on logout
+counter||Counter file for assign_username function
+crypt|1|Encrypt (1) or not encrypt (0) passwords
+database|userdb|Sets user database table
+db_acl|db_acl|Set field for database access control storage
+expire_field|expiration|Set field for expiration date
+file_acl|file_acl|Set field for file access control storage
+force_lower|0|Force possibly upper-case database fields to lower case session variable names
+ignore_case|0|Ignore case in usernames/passwords
+indirect_login||Log in field if different than real username
+logfile|error.log|File to log authentications/errors
+md5|0|Use MD5 for encryption algorithm instead of crypt
+no_get|0|Don't get values from database on login
+no_login|0|Log people in to accounts even if they are already logged in
+outboard_key_col||Set field providing key for outboard tables
+outboard||Set fields that live in another table
+pass_field|password|Set field name for password
+passminlen|2|Minimum length for password
+pref_field|preferences|Set field name for preferences
+scratch||Fields to set in user Scratch space (instead of Values)
+sql_counter||SQL counter spec (sequence or AUTO_INCREMENT) for assign_username function
+super_field|super|Field to determine superuser status if admin profile
+time_field|time|Set field for storing last login time
+unix_time|0|Set if unix (seconds since 1970) time to go in log files
+userminlen|2|Minimum length for username
+username_mask||Regular expression usernames must not match
+!endblock
+
+These are set in a C<catalog.cfg> file with something like:
+
+ UserDB default crypt 0
+ UserDB admin crypt 1
+ UserDB admin md5 1
+
+where C<default> or C<admin> is the name of the profile to set. These can
+be overriden if passed in the tag:
+
+ [userdb userminlen=6 new-account=1]
+
+H2: UserTag
+
+Defines a catalog-based UserTag that will run under Safe.pm restrictions.
+For many purposes, a global UserTag (CfgUserTagGlobal) is better.
H2: ValuesDefault
More information about the docs
mailing list