/[drupal]/contributions/modules/update_status_aggregator/INSTALL.txt
ViewVC logotype

Contents of /contributions/modules/update_status_aggregator/INSTALL.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.2 - (show annotations) (download)
Fri Mar 14 19:19:25 2008 UTC (20 months, 1 week ago) by yrocq
Branch: MAIN
CVS Tags: DRUPAL-5--1-0-RC1, DRUPAL-5--1-0-RC2, DRUPAL-5--1-1, DRUPAL-5--1-0, DRUPAL-5--1-3, DRUPAL-5--1-2, HEAD
Branch point for: DRUPAL-5--2, DRUPAL-5, DRUPAL-6--2
Changes since 1.1: +26 -85 lines
File MIME type: text/plain
Changed README + menu labels
1 ------------
2 Description
3 ------------
4
5 Update status aggregator is comprised of two components: a "client" module and a "server" module. The client (update_status_notifier.module), to be enabled on all sites that are to report to the central tracker, sends a list of installed modules and their status to the tracking site via xmlrpc when cron is run. This information is taken from the update status module. The server component (update_status_aggregator.module), to be enabled on the tracking site only, receives these lists from all the clients and creates nodes for each module on each site. These nodes subsequently get updated everytime the cron is run on the tracked sites. For the tracked sites to have the right to create these nodes, the keys of the tracked sites need to be entered into the tracker site.
6
7 This also comes with a pre-packaged view (Views modules required) listing all the nodes created that allows one to filter the resulting list of node by site, by status and/or by module.
8
9 ------------
10 Requirements
11 ------------
12
13 - Drupal 5.x
14
15 - update status module (http://drupal.org/project/update_status) should be installed and enabled.
16
17 - For the client, cron is required (more details below).
18
19 --------------------------------
20 Optional modules
21 --------------------------------
22
23 - Views (http://drupal.org/project/views)
24
25 - Poormanscron (http://drupal.org/project/poormanscron)
26 Since the update_status_aggregator module requires that cron be run regularly, you'll need to have a cron job setup for your site. If your site doesn't already have cron running on a regular basis, and you don't have the possibility of creating a cron job via your host's control panel or system administrator, you can install the poormanscron module to replicate this functionality.
27
28
29 ------------
30 Installation
31 ------------
32
33 - Copy the entire update_status_aggregator directory into your modules directory (e.g. sites/all/modules).
34
35 - Enable the server (update_status_aggregator.module) on the tracker site and the client (update_status_notifier.module) on all the tracked sites module, depending on which site you are, in the Modules admin pages of each:
36 Administer > Site building > Modules
37
38 - Be sure that you have the update_status.module enabled on all tracked site.
39
40 -------------
41 Configuration
42 -------------
43
44 Configure client(s):
45
46 - Go to the configuration page and set the xmlrpc address of the remote site.
47 Administer > Settings > Update status notifier (e.g.
48 http://trackeDsite.example.com/admin/settings/update_status_notifier)
49 - Copy the drupal key somewhere your gona need it later.
50 - Add the XML-RPC URL of the server/tracker site (e.g. http://trackeRsite.example.com/xmlrpc.php)
51 - Repeat this step for each site you want to track.
52
53
54 Configure server:
55
56 - Create a with the name of the remote site and the key that you copied earlier.
57 Create Content > Update status aggregator site
58
59 - If you have the Views modules installed on the tracking site, go to the Views listing page (http://trackeRsite.example.com/admin/build/views) and enable the "update_status_aggregator" view. ATTENTION: Be sure to edit the view to make it only visible to the roles that you want (i.e. to disable viewing by anonymous).
60
61
62 Run cron on client site(s):
63
64 - Run the cron on the remote sites by visiting cron.php (e.g. http://trackeDsite.example.com/cron.php) or wait until cron is automatically run.
65 - Repeat this step for each site you want to track.
66
67
68 Testing:
69 Once cron has been run on (at least one of) the tracked sites, you should see new nodes in the tracker site with the status of each module. These can be viewed either in the regular content listing page (http://trackeRsite.example.com/admin/content/node) or in the default view provided (http://trackeRsite.example.com/update_modules)
70
71
72 -------
73 Credits
74 -------
75
76 Written by Patrick Hetu (patrick@koumbit.org)
77 With the help of Robin Millette (robin@millette.info) and Yann Rocq (yann@koumbit.org)
78 Testing and documentation Omar Bickell (omar@koumbit.org) and Marc Angles (marco@koumbit.org)

  ViewVC Help
Powered by ViewVC 1.1.2