modules/trace/INSTALL.txt

// $Id$

REQUIREMENTS
------------
This version of Trace is designed for Drupal 6.x. It should work on both
Unix platforms and Windows, but the latter has not been tested.

INSTALLATION
------------

  1. Copy all the module files into a subdirectory called
     sites/all/modules/trace/ under your Drupal installation directory.

  2. Go to [Administer >> Site building >> Modules] and enable the Trace
     module. (Don't worry, tracing is NOT yet activated simply by enabling
     the module.)

  3. Go to [Administer >> Site configuration >> Tracing] to review and
     change the configuration options to your liking.

     At the very least, select whether you want tracing output to go to a
     log file or to the system log.

     IMPORTANT: to prevent any potential WSOD (white screen of death) from
     disabling access to your site, the page filter settings have been
     preset to always disable tracing on the login page (user/login) and any
     of the administration pages (admin*). This means you will always be
     able to access this settings page (admin/settings/trace) to disable
     tracing, if needed.

  4. Tracing is now ready for use. From the same screen, activate tracing
     when necessary, e.g. when debugging a problem, and deactivate it
     afterwards.

     IMPORTANT: unless you know what you're doing (i.e. have configured a
     minimal set of enabled tracing options), do NOT leave tracing active
     unattended on a busy production server, as the log file will grow
     extremely large very quickly and could bring your entire server down.

  5. (See README.txt for information on submitting bug reports.)
1	// $Id$
2
3	REQUIREMENTS
4	------------
5	This version of Trace is designed for Drupal 6.x. It should work on both
6	Unix platforms and Windows, but the latter has not been tested.
7
8	INSTALLATION
9	------------
10
11	1. Copy all the module files into a subdirectory called
12	sites/all/modules/trace/ under your Drupal installation directory.
13
14	2. Go to [Administer >> Site building >> Modules] and enable the Trace
15	module. (Don't worry, tracing is NOT yet activated simply by enabling
16	the module.)
17
18	3. Go to [Administer >> Site configuration >> Tracing] to review and
19	change the configuration options to your liking.
20
21	At the very least, select whether you want tracing output to go to a
22	log file or to the system log.
23
24	IMPORTANT: to prevent any potential WSOD (white screen of death) from
25	disabling access to your site, the page filter settings have been
26	preset to always disable tracing on the login page (user/login) and any
27	of the administration pages (admin*). This means you will always be
28	able to access this settings page (admin/settings/trace) to disable
29	tracing, if needed.
30
31	4. Tracing is now ready for use. From the same screen, activate tracing
32	when necessary, e.g. when debugging a problem, and deactivate it
33	afterwards.
34
35	IMPORTANT: unless you know what you're doing (i.e. have configured a
36	minimal set of enabled tracing options), do NOT leave tracing active
37	unattended on a busy production server, as the log file will grow
38	extremely large very quickly and could bring your entire server down.
39
40	5. (See README.txt for information on submitting bug reports.)