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