modules/role_watchdog/README.txt

$Id$

Description
---------------
Role Watchdog automatically logs all role changes made through the user profile 
or the User List. Role Watchdog can optionally monitor one or more roles for 
changes and notify members of selected roles via email whenever a change 
occurs. Role Watchdog can optionally log role changes in its own table and 
display the role history on each user's page. 

This module might be useful when there are multiple administrators for a site, 
and you need auditing or alerting of manual role changes.

2009-04-03: both the 5.x and 6.x versions now support user_save() and are 
compatible with Role Delegation. Going forward, 5.x will be supported with bug 
fixes only.


Dependencies
---------------
None


Related Modules
---------------
Role Delegation (http://drupal.org/project/role_delegation), 
RoleAssign (http://drupal.org/project/roleassign),
Administer Users by Role (http://drupal.org/project/administerusersbyrole)
  modules that enable user access to assign roles to other users where the
  auditing of Role Watchdog is a nice fit.

Role Change Notify (http://drupal.org/project/role_change_notify)
  the mirror functionality of Role Watchdog, notifying the user when a role is
  added to their account.


Installation
---------------
1. install module: copy role_watchdog directory and all its contents to your 
   modules directory
2. enable module: admin/build/modules
3. configure module: admin/user/roles/role_watchdog
4. configure access permissions: admin/user/permissions#module-role_watchdog


Usage
---------------
Role Watchdog has three modes of operation. The module will automatically start 
recording all role changes in the watchdog log. No further configuration is 
necessary for this functionality, the module will do this "out of the box".

Role Watchdog can optionally email members of selected Notify roles when 
selected Monitor roles are added or removed. This was specifically added to 
keep a closer eye on certain role changes, such as an Administrator role. At 
least one Monitor role and one Notify role must be selected for this 
functionality.

Role Watchdog can optionally log role changes in its own table and display the 
role history on each user's page. Users will need either "View role history" or 
"View own role history" access permissions to view the tab. This functionality 
was added for a more permanent audit of role history.


Download
---------------
Download package and report bugs, feature requests, or submit a patch from the 
project page on the Drupal web site.
http://drupal.org/project/role_watchdog


Author
---------------
John Money
ossemble LLC.
http://ossemble.com

Module development sponsored by LifeWire, a service of About.com, a part of 
The New York Times Company.
http://www.lifewire.com
1	$Id$
2
3	Description
4	---------------
5	Role Watchdog automatically logs all role changes made through the user profile
6	or the User List. Role Watchdog can optionally monitor one or more roles for
7	changes and notify members of selected roles via email whenever a change
8	occurs. Role Watchdog can optionally log role changes in its own table and
9	display the role history on each user's page.
10
11	This module might be useful when there are multiple administrators for a site,
12	and you need auditing or alerting of manual role changes.
13
14	2009-04-03: both the 5.x and 6.x versions now support user_save() and are
15	compatible with Role Delegation. Going forward, 5.x will be supported with bug
16	fixes only.
17
18
19	Dependencies
20	---------------
21	None
22
23
24	Related Modules
25	---------------
26	Role Delegation (http://drupal.org/project/role_delegation),
27	RoleAssign (http://drupal.org/project/roleassign),
28	Administer Users by Role (http://drupal.org/project/administerusersbyrole)
29	modules that enable user access to assign roles to other users where the
30	auditing of Role Watchdog is a nice fit.
31
32	Role Change Notify (http://drupal.org/project/role_change_notify)
33	the mirror functionality of Role Watchdog, notifying the user when a role is
34	added to their account.
35
36
37	Installation
38	---------------
39	1. install module: copy role_watchdog directory and all its contents to your
40	modules directory
41	2. enable module: admin/build/modules
42	3. configure module: admin/user/roles/role_watchdog
43	4. configure access permissions: admin/user/permissions#module-role_watchdog
44
45
46	Usage
47	---------------
48	Role Watchdog has three modes of operation. The module will automatically start
49	recording all role changes in the watchdog log. No further configuration is
50	necessary for this functionality, the module will do this "out of the box".
51
52	Role Watchdog can optionally email members of selected Notify roles when
53	selected Monitor roles are added or removed. This was specifically added to
54	keep a closer eye on certain role changes, such as an Administrator role. At
55	least one Monitor role and one Notify role must be selected for this
56	functionality.
57
58	Role Watchdog can optionally log role changes in its own table and display the
59	role history on each user's page. Users will need either "View role history" or
60	"View own role history" access permissions to view the tab. This functionality
61	was added for a more permanent audit of role history.
62
63
64	Download
65	---------------
66	Download package and report bugs, feature requests, or submit a patch from the
67	project page on the Drupal web site.
68	http://drupal.org/project/role_watchdog
69
70
71	Author
72	---------------
73	John Money
74	ossemble LLC.
75	http://ossemble.com
76
77	Module development sponsored by LifeWire, a service of About.com, a part of
78	The New York Times Company.
79	http://www.lifewire.com