increment year in copyright notices
[squirrelmail.git] / plugins / bug_report / README
CommitLineData
7aa22276 1Bug Reporter
15e6162e 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
2329d86d 38You must configure plugin before you enable it in your SquirrelMail
39installation. Plugin's configuration is stored in
40config/bug_report_config.php or plugins/bug_report/config.php files.
41Configuration options can be found in plugins/bug_report/config_default.php
42file.
43
44If both configuration files are present, plugin uses the one in
45config/ directory.
46
47By default plugin is visible only to users listed in
48plugins/bug_report/admins or config/admins file or only to user
49that owns main SquirrelMail configuration file. Other users can use
50bug_report plugin, if you set administrator's email in plugin's
51configuration and set $bug_report_allow_users option to true.
52
53Once plugin is configured, go back to the main directory, run configure
54and enable the plugin.
15e6162e 55
7aa22276 56Credits
15e6162e 57=======
7aa22276 58
59This plugin has been originally developed by Tyler Akins and is now
60maintained by the SquirrelMail Project Team.