update README to reflect inclusion in squirrelmail-core-plugins
[squirrelmail.git] / plugins / administrator / INSTALL
index f55b4a60ee9ecf46d65d77976ac1d9bf6abbb0a1..21eda18d4682e46be727b2359d0e05989256d0fd 100644 (file)
@@ -1,6 +1,6 @@
 Administrator Plugin
 --------------------
-2002 Philippe Mingo <philippe@squirrelmail.org>
+Author: Philippe Mingo <philippe@squirrelmail.org>, 2002
 
 In order to use this plugin, you must first activate it using
 conf.pl and then you must change the config/config.php files
@@ -16,3 +16,10 @@ you want to allow the use of the plugin.
 
 Use this plugin at your own risk, and always remember to make a
 backup of your config.php file before use. 
+
+Order of authentication checks
+------------------------------
+When plugin checks if user can use it, it first checks 
+plugins/administrator/admins file. If file does not exist, plugin
+checks config/admins. If plugin can't find admins file, it tries to
+use uid based authentication.