update README to reflect inclusion in squirrelmail-core-plugins
[squirrelmail.git] / plugins / administrator / INSTALL
e3106edd 1Administrator Plugin
cc4f163c 2--------------------
a9894104 3Author: Philippe Mingo <philippe@squirrelmail.org>, 2002
e3106edd 4
cc4f163c 5In order to use this plugin, you must first activate it using
6conf.pl and then you must change the config/config.php files
7permissions to 660. This file must be owned by the user who you
8want to have access to this plugin (only one user allowed) and
7b17e364 9the group must be the group of the user who is running php. This
10authentication method requires posix support in php and doesn't
33c308e5 11work, if user's id equals to 0.
e3106edd 12
cc4f163c 13An alternative method, but less secure, is to add a file called
14admins into the plugin folder with the names of the users that
daa192a8 15you want to allow the use of the plugin.
fba9ad27 16
cc4f163c 17Use this plugin at your own risk, and always remember to make a
920c9b9b 18backup of your config.php file before use.
a9894104 19
20Order of authentication checks
22When plugin checks if user can use it, it first checks
23plugins/administrator/admins file. If file does not exist, plugin
24checks config/admins. If plugin can't find admins file, it tries to
25use uid based authentication.