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