fsf changes, meant to be rebased on upstream
[squirrelmail.git] / plugins / bug_report / README
... / ...
CommitLineData
1Bug Reporter Plugin For SquirrelMail
2
3Need to submit a bug? Need to know valuable system information? Need
4to be accurate? This should do it for you.
5
6
7Features
8========
9
10* You save yourself a lot of typing
11* By default, this is not enabled.
12* Provides detailed setup information to help diagnose your problem
13* Has some warnings that can help out the person submitting the bug report
14
15
16Description
17===========
18
19When people stumble across a bug, which may happen in a work-in-progress,
20often times they would like to help out the software and get rid of the bug.
21Sometimes, these people don't know much about the system and how it is set
22up -- they know enough to make the bug happen for them. This bug report
23plugin is designed to gather all of the non-private information for the user
24automatically, so that the user doesn't need to know more than how to trigger
25the bug.
26
27
28Future Work
29===========
30
31* Add more data
32* Add more warnings
33
34
35Installation
36============
37
38You must configure this plugin before you enable it in your SquirrelMail
39installation. The plugin's configuration is stored in one of the
40following files:
41
42 config/bug_report_config.php
43 plugins/bug_report/config.php files.
44
45The default configuration options can be found in (copy this file to
46one of the above locations and then edit it to suit you):
47
48 plugins/bug_report/config_default.php
49
50If both configuration files are present, this plugin uses the one in
51the config/ directory.
52
53By default, the plugin will only be visible to users listed in the
54following files:
55
56 plugins/bug_report/admins
57 config/admins
58
59... or only to the user that owns the main SquirrelMail configuration
60file. Other users can use the bug_report plugin if you set a value for
61the administrator's email address in the plugin configuration file and
62set $bug_report_allow_users option to TRUE.
63
64Once the plugin is configured, go back to the main SquirrelMail
65directory, run "configure" and enable the plugin.
66
67
68Credits
69=======
70
71This plugin has been originally developed by Tyler Akins and is now
72maintained by the SquirrelMail Project Team.