Admin Guide Reference for Administrators MantisBT Development Team <mantisbt-de
Admin Guide Reference for Administrators MantisBT Development Team <mantisbt-dev@lists.sourceforge.net> Admin Guide: Reference for Administrators by MantisBT Development Team Abstract This book is targeted at MantisBT administrators, and documents the installation, upgrade, configuration, customization and administration tasks required to operate the software. Copyright © 2016 MantisBT team. This material may only be distributed subject to the terms and conditions set forth in the GNU Free Documentation License (GFDL), V1.2 or later (the latest version is presently available at http://www.gnu.org/licenses/fdl.txt). Table of Contents 1. About MantisBT ............................................................................................................. 1 What is MantisBT? ..................................................................................................... 1 Who should read this manual? ...................................................................................... 1 License ..................................................................................................................... 1 How to get it? ............................................................................................................ 1 About the Name ......................................................................................................... 1 History ...................................................................................................................... 2 Support ..................................................................................................................... 2 MantisBT News .......................................................................................................... 3 Versioning ................................................................................................................. 3 2. Installation ..................................................................................................................... 4 Overview ................................................................................................................... 4 System Requirements .................................................................................................. 4 Server Hardware Requirements ............................................................................. 4 Server Software Requirements .............................................................................. 4 Client Requirements ............................................................................................ 6 Pre-installation / upgrade tasks ...................................................................................... 7 New Installation ......................................................................................................... 7 Upgrading .................................................................................................................. 8 Configure your installation ......................................................................................... 10 Post-installation and upgrade tasks ............................................................................... 10 Post-installation tasks ................................................................................................. 11 Post-upgrade tasks ..................................................................................................... 11 Backups ................................................................................................................... 12 MySQL Backups ............................................................................................... 12 Uninstall .................................................................................................................. 12 3. User Management .......................................................................................................... 14 Creating User Accounts ............................................................................................. 14 Enabling/Disabling User Accounts ............................................................................... 14 Deleting User Accounts ............................................................................................. 15 User Signup ............................................................................................................. 15 Forgot Password and Reset Password ........................................................................... 15 Impersonating a user .................................................................................................. 16 Changing Password ................................................................................................... 16 Pruning User Accounts .............................................................................................. 16 Authorization and Access Levels ................................................................................. 16 Auto Creation of Accounts on Login ............................................................................ 17 User Preferences ....................................................................................................... 17 User Profiles ............................................................................................................ 18 4. Issue Lifecycle and Workflow ......................................................................................... 19 Issue Creation ........................................................................................................... 19 Issue Statuses ........................................................................................................... 19 Workflow ................................................................................................................ 20 Workflow Transitions ........................................................................................ 20 Workflow Thresholds ........................................................................................ 21 5. Configuration ................................................................................................................ 23 Introduction .............................................................................................................. 23 Database .................................................................................................................. 23 Path ........................................................................................................................ 24 Webserver ................................................................................................................ 25 Configuration Settings ................................................................................................ 26 iii Admin Guide Security and Cryptography ......................................................................................... 26 Signup and Lost Password .......................................................................................... 27 Email ...................................................................................................................... 28 DKIM signature ................................................................................................ 32 S/MIME signature ............................................................................................. 33 Version .................................................................................................................... 34 Language ................................................................................................................. 34 Display .................................................................................................................... 35 Time ....................................................................................................................... 37 Date ........................................................................................................................ 38 Time Zone ............................................................................................................... 38 News ....................................................................................................................... 39 Default Preferences ................................................................................................... 39 Summary ................................................................................................................. 41 Bugnote ................................................................................................................... 43 File Upload .............................................................................................................. 43 HTML ..................................................................................................................... 44 Authentication .......................................................................................................... 46 Global authentication parameters ......................................................................... 46 LDAP authentication method parameters ............................................................... 46 Status Settings .......................................................................................................... 49 Filters ...................................................................................................................... 51 Misc ........................................................................................................................ 52 Cookies ................................................................................................................... 54 Speed Optimisation ................................................................................................... 55 Reminders ................................................................................................................ 55 Bug History ............................................................................................................. 55 Sponsorship .............................................................................................................. 56 Custom Fields .......................................................................................................... 56 My View Settings ..................................................................................................... 57 Relationship Graphs ................................................................................................... 57 Wiki Integration ........................................................................................................ 58 Sub-Projects ............................................................................................................. 59 Field Visibility .......................................................................................................... 59 System Logging and Debugging .................................................................................. 60 Time Tracking .......................................................................................................... 64 API ......................................................................................................................... 64 Disabling the webservice API ............................................................................. 65 Anti-Spam Configuration ............................................................................................ 65 Due Date ................................................................................................................. 65 User Management ..................................................................................................... 66 View Page Settings ................................................................................................... 66 Issues visibility ......................................................................................................... 66 Public/Private view status ................................................................................... 66 Limited view configuration ................................................................................. 66 "Limit reporters" configuration (deprecated) .......................................................... 67 6. Page descriptions ........................................................................................................... 68 Login page ............................................................................................................... 68 Main page ................................................................................................................ 68 View Issues page ...................................................................................................... 68 Issue View page ....................................................................................................... 69 Issue Change Status page ........................................................................................... 69 Issue Edit page ......................................................................................................... 70 My Account Page ..................................................................................................... 70 iv Admin Guide Preferences ....................................................................................................... 70 Profiles ............................................................................................................ 70 Manage Columns .............................................................................................. 70 API Tokens ...................................................................................................... 70 System Management Pages ......................................................................................... 71 Manage Users ................................................................................................... 71 Manage Projects Page ........................................................................................ 71 Manage Custom Fields ....................................................................................... 71 Manage Global Profiles ...................................................................................... 72 Manage Configuration ........................................................................................ 72 Monitor Issue ........................................................................................................... 75 Reopen Issue ............................................................................................................ 75 Delete Issue ............................................................................................................. 75 Close Issue ............................................................................................................... 76 Assign to Me ........................................................................................................... 76 Resolve Issue ........................................................................................................... 76 News Syndication ..................................................................................................... 76 7. Customizing MantisBT ................................................................................................... 77 Strings / Translations ................................................................................................. 77 Custom Fields .......................................................................................................... 77 Overview ......................................................................................................... 77 Custom Field Definition ..................................................................................... 78 Adding/Editing Custom Fields ............................................................................. 80 Linking/Unlinking/Ordering Existing Custom Fields in Projects ................................ 80 Localizing Custom Field Names .......................................................................... 80 Dynamic default values ...................................................................................... 81 Dynamic values for Enumeration Custom Fields ..................................................... 81 Enumerations ............................................................................................................ 83 Email Notifications .................................................................................................... 85 Customizing Status Values ......................................................................................... 86 Custom Functions ..................................................................................................... 88 Default Custom Functions .................................................................................. 88 Example Custom Function Override ..................................................................... 89 8. Authentication ............................................................................................................... 91 Standard Authentication ............................................................................................. 91 LDAP and Microsoft Active Directory .......................................................................... 91 Basic Authentication .................................................................................................. 91 HTTP Authentication ................................................................................................. 92 Deprecated authentication methods ............................................................................... 92 9. Troubleshooting ............................................................................................................ 93 Application Errors ..................................................................................................... 93 Error 2800 - Invalid form security token ............................................................... 93 10. Project Management ..................................................................................................... 95 Change Log ............................................................................................................. 95 Roadmap ................................................................................................................. 97 Time Tracking .......................................................................................................... 99 Graphs ..................................................................................................................... 99 Summary Page .......................................................................................................... 99 11. Contributing to MantisBT ............................................................................................ 101 Talent and Time ...................................................................................................... 101 Recommend MantisBT to Others ............................................................................... 101 Blog about MantisBT ............................................................................................... 101 Integrate with MantisBT ........................................................................................... 101 A. Revision History ......................................................................................................... 102 v List of Tables 6.1. Issues ........................................................................................................................ 74 vi Chapter 1. About MantisBT What is MantisBT? MantisBT is a web based bug tracking system that was first made available to the public in November 2000. Over time it has matured and gained a lot of popularity, and now it has become one of the most popular open source bug/issue tracking systems. MantisBT is developed in PHP, with support to multiple database backends including MySQL, MS SQL and PostgreSQL. MantisBT, as a PHP script, can run on any operating system that is supported by PHP and has support for one of the DBMSes that are supported. MantisBT is known to run fine on Windows, Linux, macOS and a variety of Unix operating systems. Who should read this manual? This manual is targeted for the person responsible for evaluating, installing and maintaining MantisBT in a company. Typically we refer to this person as the MantisBT administrator. License MantisBT is released under the terms of GNU General Public License (GPL) [https://www.gnu.org/ copyleft/gpl.html]. MantisBT is free to use and modify. It is free to redistribute as long as you abide by the distribution terms of the GPL [https://www.gnu.org/copyleft/gpl.html]. How to get it? MantisBT is available in several Linux distributions including: Debian, Ubuntu, Fedora, Gentoo, Frugalware and others. Hence, if you are running Linux, start by checking if your distribution has a package for MantisBT. If not, or if the package is not up-to-date with the latest MantisBT version, then you may want to download it directly from here [https://mantisbt.org/download.php]. For Windows, macOS and other operating systems, use the link provided above to download MantisBT. The download is compressed in tar.gz or zip format. Both formats can be unpacked using tools like 7-Zip [https://www.7-zip.org/] (in case of Windows). Note that at any point in time there are typically two "latest" MantisBT releases that are available for download. The latest production release (stable), and the latest development release which can be an alpha or a release candidate. It is not recommended to use development releases in production specially if it is still in the alpha stage unless the administrator is familiar with PHP and is able to troubleshoot and fix any issues that may arise. About the Name When initially seeking to name this project Ken ran into a problem every programmer encounters. What is a good name? It has to be descriptive, unique, and not too verbose. Additionally having multiple meanings would be a nice touch. Quickly ruled out were php*Something* names which, incidentally, although popular, do not seem to be condoned by the PHP Group developers. Drawing inspiration from Open Source projects like Apache, Mozilla, Gnome, and so forth resulted in two eventual choices: Dragonfly and Mantis. Dragonfly was already the name of a webmail package. So the name became Mantis. 1 About MantisBT Praying Mantis are insects that feed primarily on other insects and bugs. They are extremely desirable in agriculture as they devour insects that feed on crops. They are also extremely elegant looking creatures. So, we have a name that is fairly distinctive and descriptive in multiple ways. The BT suffix stands for "Bug Tracker" and distinguishes this project from general usage of the word Mantis. However, over time the project was typically referred to as Mantis. History Kenzaburo Ito and a friend originally created a bug tracker as an internal tool for their pet project. A search for good, free packages came up with nothing suitable so they wrote their own. After a rewrite and cleanup it was made available to the public via the GNU General Public License (GPL). The GPL was chosen partly because of his belief that development tools should be cheap or free. In 2002, Ken was joined by Jeroen Latour, Victor Boctor and Julian Fitzell to be the administrators and the core development team of MantisBT. This marks a new era in MantisBT lifetime where it is now a team project. Support There are plenty of resources to help answer support queries. Following are the main ones: • Forums [https://mantisbt.org/forums/] - The forums are one of the most popular destinations for getting MantisBT support. Start off by searching the forums for your questions, if not found, then go ahead and submit a question. • Mailing lists [http://www.mantisbt.org/mailinglists.php] - Several lists are uploads/s3/ admin-guide 1 .pdf
Documents similaires
-
27
-
0
-
0
Licence et utilisation
Gratuit pour un usage personnel Attribution requise- Détails
- Publié le Dec 17, 2022
- Catégorie Creative Arts / Ar...
- Langue French
- Taille du fichier 0.4696MB