Administrator Plugin
--------------------- 2002 Philippe Mingo <philippe@squirrelmail.org>
+--------------------
-This is still untested and unfinished alpha code.
+In order to use this plugin, you must first activate it using
+conf.pl and then you must change the config/config.php files
+permissions to 660. This file must be owned by the user who you
+want to have access to this plugin (only one user allowed) and
+the group must be the group of the user who is running php. This
+authentication method requires posix support in php and doesn't
+work, if user's id equals to 0.
-In order to use the plugin you must activate it through conf.pl
-and change its permissions to 660. That file must be owned by
-the user you want to have access to that plugin (only one) and
-the group of the user that is running php.
+An alternative method, but less secure, is to add a file called
+admins into the plugin folder with the names of the users that
+you want to allow the use of the plugin.
-Use this plugin at your won risk, and never before to make a backup
-of the config.php file. The code is not tested and not finished.
+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.
+
+
+Credits
+-------
+
+The administrator plugin was originally created by Philippe Mingo, and is now
+maintained by the SquirrelMail Project Team.
projects / squirrelmail.git / blobdiff