Recent changes to Configuration

WikiPage Configuration modified by Andrew Kester

Andrew Kester — Wed, 11 Jul 2012 23:01:26 -0000

--- v4
+++ v5
@@ -7,6 +7,8 @@
     $CONFIG['setting'] = value;
 
 in the program.
+
+More configuration options are available.  They are included and commented in the config section of the library.
 
 Basic Configuration
 ===================
@@ -38,8 +40,6 @@
 
 **use_local_db_funcs** - (*TRUE/FALSE) - Explained in the [Built-in MySQL] section.
 
-**session_expire** - (int) - After x seconds of inactivity (not loading a new page) the user is marked inactive and must login again.  (-1 disables, must be enabled to have logout functionality).
-
 **realm** - (string) - The string that is passed to the user to identify your site.
 
 VERY IMPORTANT!

WikiPage Configuration modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 20:22:34 -0000

--- v3
+++ v4
@@ -37,3 +37,12 @@
 **wait_time** - (int) - Time in seconds the system sleeps after a failed auth.
 
 **use_local_db_funcs** - (*TRUE/FALSE) - Explained in the [Built-in MySQL] section.
+
+**session_expire** - (int) - After x seconds of inactivity (not loading a new page) the user is marked inactive and must login again.  (-1 disables, must be enabled to have logout functionality).
+
+**realm** - (string) - The string that is passed to the user to identify your site.
+
+VERY IMPORTANT!
+---------------
+The realm value is part of the hashed string used to verify the user!  Changing the value will break ***ALL*** of the passwords in the database!  (Changing back will mend the issue).
+In future versions we will develop a way to fix this, but for now don't change it!

WikiPage Configuration modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 20:18:00 -0000

--- v2
+++ v3
@@ -32,4 +32,8 @@
 
 **redirect_on_logout_url** - (string) - The URL to send the user to if redirect_on_logout is true.
 
+**logout_text** - (string) - The text to send to the user when they logout but aren't redirected.
 
+**wait_time** - (int) - Time in seconds the system sleeps after a failed auth.
+
+**use_local_db_funcs** - (*TRUE/FALSE) - Explained in the [Built-in MySQL] section.

WikiPage Configuration modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 20:09:03 -0000

--- v1
+++ v2
@@ -1,13 +1,18 @@
 Usually, you will only have to edit the basic settings in order to get the file working for your environment.
 
 All the names shown are encapsulated in a variable in the file:
-ie. **setting** becomes $CONFIG['setting'] in the program.
+ie. **setting** becomes 
+
+    :::php
+    $CONFIG['setting'] = value;
+
+in the program.
 
 Basic Configuration
 ===================
 (Not all these settings are found under the basic tab)
 
-**quit_on_error** - ([TRUE]/FALSE) - If set true, the program will quit on an error, dumping the error text to the user.
+**quit_on_error** - (*TRUE/FALSE) - If set true, the program will quit on an error, dumping the error text to the user.
 
 **error_handler** - (string) - The error handler function.  Required if quit_on_error is FALSE.
 The system will call the function using the following method:
@@ -17,9 +22,14 @@
 
 Where $message is the error text to be logged or printed.
 
-**redirect_on_failure** - (TRUE/[FALSE]) - If set true, the user will be redirected to the specified URL if they hit 'cancel' while logging in (or if the browser doesn't honor the digest request).
+**redirect_on_failure** - (TRUE/*FALSE) - If set true, the user will be redirected to the specified URL if they hit 'cancel' while logging in (or if the browser doesn't honor the digest request).
 
 **redirect_on_failure_url** - (string) - The URL the user is sent to when they hit cancel.
 
 **fail_text** - (string) - The text that is echo'd if the login is cancelled. (Only seen if the user is not redirected)
 
+**redirect_on_logout** - (TRUE/*FALSE) - Should the user be redirected after they are logged out.
+
+**redirect_on_logout_url** - (string) - The URL to send the user to if redirect_on_logout is true.
+
+

WikiPage Configuration modified by Andrew Kester

Andrew Kester — Sat, 07 Jul 2012 20:05:38 -0000

Usually, you will only have to edit the basic settings in order to get the file working for your environment. All the names shown are encapsulated in a variable in the file: ie. **setting** becomes $CONFIG['setting'] in the program. Basic Configuration =================== (Not all these settings are found under the basic tab) **quit_on_error** - ([TRUE]/FALSE) - If set true, the program will quit on an error, dumping the error text to the user. **error_handler** - (string) - The error handler function. Required if quit_on_error is FALSE. The system will call the function using the following method: :::php function($message); Where $message is the error text to be logged or printed. **redirect_on_failure** - (TRUE/[FALSE]) - If set true, the user will be redirected to the specified URL if they hit 'cancel' while logging in (or if the browser doesn't honor the digest request). **redirect_on_failure_url** - (string) - The URL the user is sent to when they hit cancel. **fail_text** - (string) - The text that is echo'd if the login is cancelled. (Only seen if the user is not redirected)