Admin Guide Reference For Administrators Mantis BT 2.0 En US
User Manual: Pdf
Open the PDF directly: View PDF .
Page Count: 116
MantisBT 2.0
Admin Guide
Reference for Administrators
MantisBT Development Team
Admin Guide
MantisBT 2.0 Admin Guide
Reference for Administrators
Author
MantisBT Development Team
mantisbt-dev@lists.sourceforge.net
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).
This book is targeted at MantisBT administrators, and documents the installation, upgrade, configuration, customization and administration tasks required to operate the software.
1. About
1.1.
1.2.
1.3.
1.4.
1.5.
1.6.
1.7.
1.8.
1.9.
MantisBT
What is MantisBT? .......................................................................................................
Who should read this manual? ......................................................................................
License .........................................................................................................................
How to get it? ...............................................................................................................
About the Name ...........................................................................................................
History ..........................................................................................................................
Support ........................................................................................................................
MantisBT News ............................................................................................................
Versioning ....................................................................................................................
1
1
1
1
1
1
2
2
3
3
2. Installation
5
2.1. Overview ...................................................................................................................... 5
2.2. System Requirements ................................................................................................... 5
2.2.1. Server Hardware Requirements .......................................................................... 5
2.2.2. Server Software Requirements ........................................................................... 5
2.2.3. Client Requirements ........................................................................................... 8
2.3. Pre-installation / upgrade tasks ...................................................................................... 8
2.4. New Installation ............................................................................................................ 9
2.5. Upgrading ................................................................................................................... 10
2.6. Configure your installation ........................................................................................... 11
2.7. Post-installation and upgrade tasks .............................................................................. 11
2.8. Post-installation tasks .................................................................................................. 12
2.9. Post-upgrade tasks ..................................................................................................... 12
2.10. Backups .................................................................................................................... 13
2.10.1. MySQL Backups ............................................................................................. 13
2.11. Uninstall .................................................................................................................... 13
3. User Management
3.1. Creating User Accounts ..............................................................................................
3.2. Enabling/Disabling User Accounts ................................................................................
3.3. Deleting User Accounts ...............................................................................................
3.4. User Signup ................................................................................................................
3.5. Forgot Password and Reset Password .........................................................................
3.6. Impersonating a user ..................................................................................................
3.7. Changing Password ....................................................................................................
3.8. Pruning User Accounts ................................................................................................
3.9. Authorization and Access Levels .................................................................................
3.10. Auto Creation of Accounts on Login ...........................................................................
3.11. User Preferences ......................................................................................................
3.12. User Profiles .............................................................................................................
15
15
15
16
16
16
17
17
17
17
18
18
19
4. Issue Lifecycle and Workflow
4.1. Issue Creation ............................................................................................................
4.2. Issue Statuses ............................................................................................................
4.3. Workflow .....................................................................................................................
4.3.1. Workflow Transitions ........................................................................................
4.3.2. Workflow Thresholds ........................................................................................
21
21
21
22
22
23
5. Configuration
5.1. Introduction .................................................................................................................
5.2. Database ....................................................................................................................
5.3. Path ...........................................................................................................................
5.4. Webserver ..................................................................................................................
5.5. Configuration Settings .................................................................................................
5.6. Security and Cryptography ..........................................................................................
27
27
27
28
29
30
31
iii
Admin Guide
5.7. Signup and Lost Password .......................................................................................... 32
5.8. Email .......................................................................................................................... 32
5.9. Version ....................................................................................................................... 38
5.10. Language .................................................................................................................. 38
5.11. Display ..................................................................................................................... 38
5.12. Time ......................................................................................................................... 41
5.13. Date ......................................................................................................................... 41
5.14. Time Zone ................................................................................................................ 42
5.15. News ........................................................................................................................ 42
5.16. Default Preferences ................................................................................................... 43
5.17. Summary .................................................................................................................. 45
5.18. Bugnote .................................................................................................................... 46
5.19. File Upload ............................................................................................................... 46
5.20. HTML ....................................................................................................................... 48
5.21. Authentication ........................................................................................................... 49
5.21.1. Global authentication parameters .................................................................... 49
5.21.2. LDAP authentication method parameters ......................................................... 50
5.22. Status Settings .......................................................................................................... 52
5.23. Filters ....................................................................................................................... 54
5.24. Misc .......................................................................................................................... 54
5.25. Cookies .................................................................................................................... 56
5.26. Speed Optimisation ................................................................................................... 57
5.27. Reminders ................................................................................................................ 57
5.28. Bug History ............................................................................................................... 58
5.29. Sponsorship .............................................................................................................. 58
5.30. Custom Fields ........................................................................................................... 59
5.31. My View Settings ...................................................................................................... 59
5.32. Relationship Graphs .................................................................................................. 59
5.33. Wiki Integration ......................................................................................................... 60
5.34. Sub-Projects ............................................................................................................. 61
5.35. Field Visibility ............................................................................................................ 61
5.36. System Logging and Debugging ................................................................................ 62
5.37. Time Tracking ........................................................................................................... 67
5.38. API ........................................................................................................................... 67
5.38.1. Disabling the webservice API .......................................................................... 68
5.39. Anti-Spam Configuration ............................................................................................ 68
5.40. Due Date .................................................................................................................. 68
5.41. User Management ..................................................................................................... 69
5.42. View Page Settings ................................................................................................... 69
6. Page descriptions
6.1. Login page .................................................................................................................
6.2. Main page ..................................................................................................................
6.3. View Issues page .......................................................................................................
6.4. Issue View page .........................................................................................................
6.5. Issue Change Status page ..........................................................................................
6.6. Issue Edit page ...........................................................................................................
6.7. My Account Page .......................................................................................................
6.7.1. Preferences ......................................................................................................
6.7.2. Profiles ............................................................................................................
6.7.3. Manage Columns .............................................................................................
6.7.4. API Tokens ......................................................................................................
6.8. System Management Pages ........................................................................................
6.8.1. Manage Users .................................................................................................
iv
71
71
71
71
72
72
73
73
73
73
73
73
74
74
6.8.2. Manage Projects Page .....................................................................................
6.8.3. Manage Custom Fields .....................................................................................
6.8.4. Manage Global Profiles ....................................................................................
6.8.5. Manage Configuration ......................................................................................
6.9. Monitor Issue ..............................................................................................................
6.10. Reopen Issue ...........................................................................................................
6.11. Delete Issue ..............................................................................................................
6.12. Close Issue ...............................................................................................................
6.13. Assign to Me ............................................................................................................
6.14. Resolve Issue ...........................................................................................................
6.15. News Syndication ......................................................................................................
74
74
76
76
79
80
80
80
80
80
80
7. Customizing MantisBT
81
7.1. Strings / Translations ................................................................................................... 81
7.2. Custom Fields ............................................................................................................. 82
7.2.1. Overview .......................................................................................................... 82
7.2.2. Custom Field Definition .................................................................................... 82
7.2.3. Adding/Editing Custom Fields ........................................................................... 84
7.2.4. Linking/Unlinking/Ordering Existing Custom Fields in Projects ............................. 84
7.2.5. Localizing Custom Field Names ........................................................................ 85
7.2.6. Dynamic default values .................................................................................... 86
7.2.7. Dynamic values for Enumeration Custom Fields ................................................ 86
7.3. Enumerations .............................................................................................................. 88
7.4. Email Notifications ....................................................................................................... 89
7.5. Customizing Status Values .......................................................................................... 91
7.6. Custom Functions ....................................................................................................... 93
7.6.1. Default Custom Functions ................................................................................. 93
7.6.2. Example Custom Function Override .................................................................. 94
8. Authentication
8.1. Standard Authentication ..............................................................................................
8.2. LDAP and Microsoft Active Directory ...........................................................................
8.3. Basic Authentication ....................................................................................................
8.4. HTTP Authentication ...................................................................................................
8.5. Deprecated authentication methods .............................................................................
97
97
97
97
98
98
9. Troubleshooting
99
9.1. Application Errors ........................................................................................................ 99
9.1.1. Error 2800 - Invalid form security token ............................................................. 99
10. Project Management
10.1. Change Log ............................................................................................................
10.2. Roadmap ................................................................................................................
10.3. Time Tracking .........................................................................................................
10.4. Graphs ....................................................................................................................
10.5. Summary Page .......................................................................................................
101
101
103
105
105
105
11. Contributing to MantisBT
11.1. Talent and Time ......................................................................................................
11.2. Recommend MantisBT to Others .............................................................................
11.3. Blog about MantisBT ...............................................................................................
11.4. Integrate with MantisBT ...........................................................................................
107
107
107
107
107
A. Revision History
109
v
vi
Chapter 1.
About MantisBT
1.1. 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,
OS/2, Mac OS X, System i and a variety of Unix operating systems.
1.2. 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.
1.3. License
1
MantisBT is released under the terms of GNU General Public License (GPL) . MantisBT is free to use
2
and modify. It is free to redistribute as long as you abide by the distribution terms of the GPL .
1.4. 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
3
want to download it directly from here .
For Windows, Mac OS X 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
4
like 7-Zip (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.
1.5. 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
1
http://www.gnu.org/copyleft/gpl.html
http://www.gnu.org/copyleft/gpl.html
3
http://www.mantisbt.org/download.php
4
http://www.7-zip.org/
2
1
Chapter 1. About MantisBT
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.
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.
1.6. 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.
1.7. Support
There are plenty of resources to help answer support queries. Following are the main ones:
5
• 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.
6
• Mailing lists - Several lists are available, each of them with its own, specific purpose. Note that
posting messages is restricted to subscribers so you will have to register before you can send messages; however, there are public archives available if you're only interested in reading.
7
• Gitter is a browser-based, on-line chat that has mainly replaced the team's use of IRC. In the main
chat room, you can have a live discussion with the developers and other MantisBT users. Gitter sup8
ports all modern browsers and also offers Android and iOS-based clients, as well as an IRC bridge .
9
• IRC - The IRC channel not very active anymore, as the developers have moved on to using Gitter
for live discussions; nevertheless, the channel is still open. There are many free IRC clients: XChat
10
11
12
(for Linux), HexChat , IceChat amongst others. You can also use Web Chat to connect to IRC
via your web browser, which may also be useful when you're behind a firewall that blocks the IRC
13
port. The IRC channel logs are archived and made available on the MantisBT web site .
14
• Wiki - The MantisBT Wiki has information related to "How To (recipes)", FAQ, feature requirements, plugins etc.
5
http://www.mantisbt.org/forums/
http://www.mantisbt.org/mailinglists.php
7
https://gitter.im/mantisbt/mantisbt
8
https://irc.gitter.im/
9
http://www.mantisbt.org/irc.php
10
http://hexchat.github.io/
11
http://www.icechat.net/
12
http://webchat.freenode.net/
13
http://www.mantisbt.org/irclogs.php
14
http://www.mantisbt.org
6
2
MantisBT News
• Search - A good way for locating an answer to your question or finding more information about a
topic is to search across all MantisBT website and the Internet via your favorite search engine, e.g.
15
16
Google or Bing .
Note
Support questions should not be sent directly to MantisBT developers or through the MantisBT
website's contact pages.
Also, our bug tracker
for support requests.
17
is reserved for reporting issues with the software, and must not be used
1.8. MantisBT News
There are several ways to keep up to date with MantisBT news. These include:
• We send release announcements and important updates to users registered on our official bugtrack18
er . To get onto our mailing list, users will have to signup there and verify their email address. This
same account can also be used to report, monitor, and comment on issues relating to MantisBT.
19
• MantisBT Blog is used to communicate announcements about new releases, topics relating to
MantisBT, etc. Users are encouraged to subscribe to the RSS feed to know when new posts are
posted there.
20
• Twitter is used to notify users about up-to-date details about what is happening with MantisBT development. Twitter users are encouraged to follow "@mantisbt".
1.9. Versioning
21
Our release numbering convention follows the guidelines of Semantic Versioning . Given a version
number Major.Minor.Patch and an optional Suffix (eg. 1.3.0-rc.1):
• Major - Indicates a very large change in the core package. Rewrites or major milestones. API
changes which are not backwards-compatible.
• Minor - Introduction of new features or significant changes in functionality, in a backwards-compatible manner.
• Patch - Bug fixes, maintenance and security releases.
• Suffix - Optional, indicates a development release.
• aN or alpha.N for alpha releases,
• bN or beta.N for beta releases, or
15
http://www.google.com
http://www.bing.com
17
http://mantisbt.org/bugs/
18
http://www.mantisbt.org/bugs
19
http://www.mantisbt.org/blog/
20
http://twitter.com/mantisbt
21
http://semver.org/
16
3
Chapter 1. About MantisBT
• rcN or rc.N for release candidates.
Absence of suffix indicates a stable release.
4
Chapter 2.
Installation
This chapter explains how to install or upgrade MantisBT.
2.1. Overview
The table below contains a high-level overview of the processes. Refer to the corresponding sections
for details.
New Installation
Upgrade
1. Section 2.2, “System Requirements”
1. Section 2.3, “Pre-installation / upgrade tasks”
2. Section 2.3, “Pre-installation / upgrade tasks” 2. Section 2.10, “Backups”
3. Section 2.4, “New Installation”
3. Put the site down for maintenance
4. Section 2.6, “Configure your installation”
4. Section 2.5, “Upgrading”
5. Section 2.7, “Post-installation and upgrade
tasks”
5. Section 2.7, “Post-installation and upgrade
tasks”
6. Section 2.8, “Post-installation tasks”
6. Section 2.9, “Post-upgrade tasks”
2.2. System Requirements
2.2.1. Server Hardware Requirements
MantisBT has modest hardware requirements. It requires a computer that is able to run the server
software (see Section 2.2.2, “Server Software Requirements”).
• Server type
The server can be a shared public web server or a dedicated co-located box.
• CPU and Memory
As for any web application, you should size your server based on the traffic on the site.
• Disk
The application code is less than 30 MB.
The amount of disk space required for the database will vary depending on the RDBMS and the volume of data, the main driving factor being the expected number and size of attachments.
2.2.2. Server Software Requirements
All of the required software is free for commercial and non-commercial use (open source). Please refer
to the table in Section 2.2.2.1, “Versions compatibility table” for minimum and recommended versions.
• Operating System
MantisBT runs on Windows, MacOS, OS/2, Linux, Solaris, the BSDs, and just about anything that
supports the required server software.
• Web Server
5
Chapter 2. Installation
1
2
MantisBT is mainly tested with Microsoft IIS and Apache . However, it is expected to work with any
recent web server software.
File Extensions: MantisBT uses only .php files. If your webserver is configured for other extensions
(e.g. .PHP3, .PHTML) then you will have to request the administrator to add support for .PHP files.
3
This should be a trivial modification. Further details can be found in the PHP documentation
4
• PHP
The web server must support PHP. It can be installed as CGI or any other integration technology.
• PHP extensions
MantisBT is designed to work in as many environments as possible. Hence the required extensions
are minimal and many of them are optional affecting only one feature.
Mandatory extensions
• The extension for the RDBMS being used ( mysqli, pgsql, oci8, sqlsrv )
• mbstring - Required for Unicode (UTF-8) support.
Optional extensions
• Curl - required for the Twitter integration feature
• GD - required for the captcha feature
• Fileinfo - Guesses the MIME type of attachments
Without this extension, file attachment previews and downloads may not work correctly as
MantisBT won't be able to send the Content-Type header to a browser requesting an attachment.
This extension is included by default from PHP version 5.3.x and above.
• Database
MantisBT requires a database to store its data. The supported RDBMS are:
• MySQL (or one of its forks, e.g. MariaDB)
• PostgreSQL
Experimental support is also available for
• Microsoft SQL Server
• Oracle
Experimental support means that manual intervention by a skilled Database Administrator may be
required to complete the installation, and/or that there may be known issues or limitations when us-
1
http://www.microsoft.com/iis
http://www.apache.org/
3
http://www.php.net/manual/en/installation.php
4
http://www.php.net/
2
6
Server Software Requirements
5
ing the software. Please refer to our Issue tracker , filtering on categories db mssql and db oracle to
find out more about those.
Note
Please note that the MantisBT development team mainly works with MySQL, so testing for other drivers is not as extensive as we mainly rely on community contributions to improve support
and fix issues with other RDBMS.
We therefore recommend MySQL to store your database.
2.2.2.1. Versions compatibility table
Category
RDBMS
PHP
Web Server
Package
Minimum Version
Recommended
Comments
MySQL
5.5.35
5.6 or above
PHP extension:
mysqli
MariaDB
5.5.35
10.x or above
PHP extension:
mysqli
PostgreSQL
9.2
9.2 or later
PHP extension:
pgsql
MS SQL Server
2012
2012 or later
PHP extension:
sqlsrv
Oracle
11gR2
11gR2 or later
PHP extension:
oci8
PHP
5.5.x
7.0 or later
See above for
PHP extensions
Apache
2.2.x
2.4.x
lighttpd
1.4.x
1.4.x
nginx
1.10.x
1.10.x
IIS
7.5
8.0
Windows Server
2008 R2 SP1 or
later
Our minimum requirements are generally based on availability of support for the underlying software
by their respective vendors. In some cases, we do require a specific version because we rely on a feature that is not available in older releases.
5
https://mantisbt.org/bugs/
7
Chapter 2. Installation
Warning
Running MantisBT with versions of the software components lower than the minimum requirements listed above is not supported.
2.2.3. Client Requirements
MantisBT should run on all recent browsers in the market, including but not limited to:
• Firefox 45 and above
• Internet Explorer 10 and above
• Chrome
• Safari
• Opera
2.3. Pre-installation / upgrade tasks
These tasks cover the download and deployment of MantisBT, and should be performed prior to any
new installation or upgrade.
1. Download MantisBT (see Section 1.4, “How to get it?”)
2. Transfer the downloaded file to your webserver
This can be done using whatever method you like best (ftp, scp, etc). You will need to telnet/ssh
into the server machine for the next steps.
3. Extract the release
It is highly recommended to maintain a separate directory for each release. This not only avoids
mismatch between versions, (files may have been added or removed) but also provides an easy
path to downgrade your installation, should you need to.
The usual command is (1 step):
tar -xzf filename.tar.gz
OR (2 steps):
gunzip filename.tar.gz
tar -xf filename.tar
6
Other file archiving tools such as 7-Zip should also be able to handle decompression of the
archive.
6
http://www.7-zip.org/
8
New Installation
The extraction process should create a new directory like mantisbt-1.3.x
4. Rename the directory
For new installations, you may want to rename the directory just created to something simpler,
e.g. mantisbt
mv mantisbt-1.3.x mantisbt
2.4. New Installation
This chapter explains how to perform a new installation of MantisBT.
Start by checking Section 2.2, “System Requirements” and installing the appropriate version of required software.
Once that is done, execute the installation script. From your web browser, access
http://yoursite/mantisbt/admin/install.php
The installation procedure will go through the following steps:
1. The script checks basic parameters for the web server
2. Provide required information for the installation
• database type
• database server hostname
• user and password
Required privileges: SELECT, INSERT, UPDATE, and DELETE
• high-privileged database account
Additional privileges required: INDEX, CREATE, ALTER, and DROP
If this account is not specified, the database user will be used.
3. Click the Install/Upgrade Database button
4. The script creates the database and tables.
The default Administrator user account is created at this stage, to allow the initial login and setup
of MantisBT.
5. The script attempts to write a basic config_inc.php file to define the database connection parameters.
This operation may fail if the web server's user account does not have write permissions to the directory (which is recommended for obvious security reasons). In this case, you will have to manually create the file and copy/paste the contents from the page.
6. The script perform post installation checks on the system.
Review and correct any errors.
9
Chapter 2. Installation
2.5. Upgrading
This chapter explains how to upgrade an existing MantisBT installation.
Start by Performing the steps described in Section 2.3, “Pre-installation / upgrade tasks” above.
1. Put the site down for maintenance
cp mantis_offline.php.sample mantis_offline.php
This will prevent users from using the system while the upgrade is in progress.
2. Always Backup your code, data and config files before upgrading !
This includes your Mantis directory, your attachments, and your database. Refer to Section 2.10,
“Backups” for details.
3. Copy the configuration files
To preserve your system settings, you should copy the files listed below to subdirectory config of
the new directory. You might have to copy as well other custom files such as logo, favicon, css,
etc.
config_inc.php, the Custom Strings File (custom_strings_inc.php by default, see Section 7.1, “Strings / Translations”), custom_constants_inc.php and
custom_functions_inc.php
4. Execute the upgrade script. From your web browser, access
http://yoursite/mantisbt-NEW/admin/install.php
where mantisbt-NEW is the name of the directory where the new release was extracted
5. Provide required information for the upgrade
• high-privileged database account
Additional privileges required: INDEX, CREATE, ALTER, and DROP
If this account is not specified, the database user will be used.
6. Click the Install/Upgrade Database button
7. At the end of the upgrade, review and correct any warnings or errors.
7
http://www.mantisbt.org/bugs/view.php?id=12735
10
Configure your installation
Upgrading large databases
When processing large databases from versions older than 1.2, the upgrade script may fail during
the conversion of date fields, leaving the system in an inconsistent (i.e. partially updated) state.
In this case, you should simply restart the upgrade process, which will resume where it left off.
Note that you may have to repeat this several times, until normal completion.
7
Reference: MantisBT issue 12735 .
2.6. Configure your installation
There are many settings that you can adjust to configure and customize MantisBT. Refer to Chapter 5,
Configuration, as well as the config_defaults_inc.php file for in depth explanations of the available options. Check out also Chapter 7, Customizing MantisBT for further options to personalize your installation.
This step is normally only required for new installations, but when upgrading you may want to review
and possibly customize any new configuration options.
Open or create the file config_inc.php in subfolder config in an editor and add or modify any values as
required. These will override the default values.
You may want to use the provided config_inc.php.sample file as a starting point.
Warning
you should never edit the config_defaults_inc.php file directly, as it could cause issues with future
upgrades. Always store your custom configuration in your own config_inc.php file.
2.7. Post-installation and upgrade tasks
Instructions in this section are common to both new installations and upgrades, and should be applied
after completing either process.
1. Test your configuration
Load up admin/check/index.php to validate whether everything is setup correctly, and take corrective action as needed.
2. Delete the admin folder
Once you have confirmed that the install or upgrade process was successful, you should delete
this directory
rm -r admin
For security reasons, the scripts within this directory should not be freely accessible on a live MantisBT site, particularly one which is accessible via the Internet, as they can allow unauthorized
11
Chapter 2. Installation
people (e.g. hackers) to gain technical knowledge about the system, as well as perform administrative tasks.
Warning
Omitting this important step will leave your MantisBT instance exposed to several potentially
8
9
severe attacks, e.g. issue #23173 (if mysqli.allow_local_infile is enabled in php.ini).
2.8. Post-installation tasks
Instructions in this section should only be applied after a new installation
1. Login to your bugtracker
Use the default Administrator account. The id and password are administrator / root.
2. Create a new Administrator account
Go to Manage > Manage Users and create a new account with 'administrator' access level.
3. Disable or delete the default Administrator account
4. Create a new Project
Go to Manage > Manage Projects and create a new project
2.9. Post-upgrade tasks
Instructions in this section should only be applied after upgrading an existing installation.
1. Test the new release
Perform any additional testing as appropriate to ensure the new version does not introduce any regressions.
2. Switch the site to the new version
The commands below should be executed from the web root (or wherever the mantisbt scripts are
installed) and assume that the "live" directory (old version) is named mantisbt and the new release
directory is mantisbt-1.3.x.
mv mantisbt mantisbt-old
mv mantisbt-1.3.x mantisbt
3. Put the site back on line
rm mantis_offline.php
8
9
http://mantisbt.org/bugs/view.php?id=23173
http://php.net/manual/en/mysqli.configuration.php#ini.mysqli.allow-local-infile
12
Backups
This should be the final step in the upgrade process, as it will let users login again.
2.10. Backups
It is strongly recommended to backup your MantisBT database on a regular basis. The method to perform this operation depends on which RDBMS you use.
Backups are a complex subject, and the specificities of implementing and handling them for each
RDBMS are beyond the scope of this document. For your convenience, the section below provides a
simple method to backup MySQL databases.
You should also consider implementing backups of your MantisBT code (which includes your configs
and possibly customization), as well as issue attachments (if stored on disk) and project documents.
Warning
You should always backup your system (code and database) before upgrading !
2.10.1. MySQL Backups
MySQL databases are easy to backup using the mysqldump command:
mysqldump -u -p >
Source Exif Data:
File Type : PDF
File Type Extension : pdf
MIME Type : application/pdf
Linearized : No
Page Count : 116
Profile CMM Type : lcms
Profile Version : 2.1.0
Profile Class : Display Device Profile
Color Space Data : RGB
Profile Connection Space : XYZ
Profile Date Time : 1998:02:09 06:49:00
Profile File Signature : acsp
Primary Platform : Apple Computer Inc.
CMM Flags : Not Embedded, Independent
Device Manufacturer : IEC
Device Model : sRGB
Device Attributes : Reflective, Glossy, Positive, Color
Rendering Intent : Perceptual
Connection Space Illuminant : 0.9642 1 0.82491
Profile Creator : lcms
Profile ID : 0
Profile Copyright : Copyright (c) 1998 Hewlett-Packard Company
Profile Description : sRGB IEC61966-2.1
Media White Point : 0.95045 1 1.08905
Media Black Point : 0 0 0
Red Matrix Column : 0.43607 0.22249 0.01392
Green Matrix Column : 0.38515 0.71687 0.09708
Blue Matrix Column : 0.14307 0.06061 0.7141
Device Mfg Desc : IEC http://www.iec.ch
Device Model Desc : IEC 61966-2.1 Default RGB colour space - sRGB
Viewing Cond Desc : Reference Viewing Condition in IEC61966-2.1
Viewing Cond Illuminant : 19.6445 20.3718 16.8089
Viewing Cond Surround : 3.92889 4.07439 3.36179
Viewing Cond Illuminant Type : D50
Luminance : 76.03647 80 87.12462
Measurement Observer : CIE 1931
Measurement Backing : 0 0 0
Measurement Geometry : Unknown
Measurement Flare : 0.999%
Measurement Illuminant : D65
Technology : Cathode Ray Tube Display
Red Tone Reproduction Curve : (Binary data 2060 bytes, use -b option to extract)
Green Tone Reproduction Curve : (Binary data 2060 bytes, use -b option to extract)
Blue Tone Reproduction Curve : (Binary data 2060 bytes, use -b option to extract)
Language : en
Format : application/pdf
Title : Admin Guide - Reference for Administrators
Creator :
Date : 2017:12:30 23:20:24Z
PDF Version : 1.4
Producer : Apache FOP Version 1.1
Create Date : 2017:12:30 23:20:24Z
Creator Tool : DocBook XSL Stylesheets with Apache FOP
Metadata Date : 2017:12:30 23:20:24Z
Page Mode : UseOutlines
Author :
EXIF Metadata provided by EXIF.tools