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