[squirrelmail.git] / plugins / administrator / INSTALL

Administrator Plugin
--------------------

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.

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 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.
Commit	Line	Data
e3106edd	1	Administrator Plugin
cc4f163c	2	--------------------
e3106edd	3
cc4f163c	4	In order to use this plugin, you must first activate it using
	5	conf.pl and then you must change the config/config.php files
	6	permissions to 660. This file must be owned by the user who you
	7	want to have access to this plugin (only one user allowed) and
7b17e364	8	the group must be the group of the user who is running php. This
7b17e364	9	authentication method requires posix support in php and doesn't
33c308e5	10	work, if user's id equals to 0.
e3106edd	11
cc4f163c	12	An alternative method, but less secure, is to add a file called
cc4f163c	13	admins into the plugin folder with the names of the users that
daa192a8	14	you want to allow the use of the plugin.
fba9ad27	15
cc4f163c	16	Use this plugin at your own risk, and always remember to make a
920c9b9b	17	backup of your config.php file before use.
a9894104	18
	19	Order of authentication checks
	20	------------------------------
	21	When plugin checks if user can use it, it first checks
	22	plugins/administrator/admins file. If file does not exist, plugin
	23	checks config/admins. If plugin can't find admins file, it tries to
	24	use uid based authentication.
7aa22276	25
	26
	27	Credits
	28	-------
	29
	30	The administrator plugin was originally created by Philippe Mingo, and is now
	31	maintained by the SquirrelMail Project Team.