Installation
Following are the steps for a new MantisBT installation:
Download
Mantis
Go through MantisBT Configuration
and set the database options + whatever options where you need to
override the default values.
Test your configuration through the admin
folder
Create a new administrator account and remove the
standard user 'administrator'
Following are the steps to upgrade a MantisBT installation:See
Upgrading.The
following details the basic steps for installation on any system.
Theinstructions may seem unix-centric but should work fine on
Windows systems.Barring complications, it should take you about
10-20 minutes to install,configure, and be using MantisBT.
Summary
Tranfer files
Uncompress files
Generate database tables
Edit configuration file, if needed
PHP File extensions
Login
Add projects and users
New Installations
First, transfer the file to your webserver using whatever
method you likebest (ftp, scp, etc). You will need to telnet/ssh
into the server machine forthe next steps.
Next, untar/gunzip it to the directory that you want.The
usual command is (1 step):
tar zxvf <filename.tar.gz>
OR (2 steps):
gunzip <filename.tar.gz> tar xvf <filename.tar>
Winzip, Stuffit, and other programs should also be able to
handledecompression of the archive.At this point you may want to
rename the directory to something simpler like 'mantisbt'. You will
use the mv command to rename a directory (Windows users substitute
the "ren" command or use explorer).
mv <directoryname> mantisbt
Next we will create the necessary database tables and a
basic configurationfile.From your web server, access
http://yoursite/mantisbt/admin/install.php. This page will walk through
the following steps:
check basic parameters for the web server
prompt for the database type and location, and a database
user/passwordpair. For installion, an administrative user/password
pair can also be provided. The operating user requires SELECT,
INSERT, UPDATE, and DELETE privileges. For installation, INDEX,
CREATE, ALTER, and DROP privileges arealso required.
create the database and tables.
WARNING: A DEFAULT ADMINISTRATOR level account is created. The
account name and password are administrator / root.
Use this when you first login to MantisBT. Immediately go to Manage
and create at least one administrator level account. Immediately
after that DISABLE or DELETE the administrator account. You can
recreate it but you should delete the account to prevent the
cookie_string from being used to trick the package. It would be
even better to rename the account or delete it permanently.
REMEMBER: After setting up the package, REMOVE the default
administrator account.
write a basic "config_inc.php file to define the
database.
perform some post installation checks on the
system.
The next part involves configuring the installation to
work with yourspecific setup.Open the file in an editor and add
anyother values that are required. There aremany more that you can
use to customize your MantisBT installation.
SeeConfiguration for
in depth explanations.The file will overwrite the default values
with those necessary for setup.You can load up admin/check.php to
see if you set things up correctly.
NOTE: check.php sometimes reports the value of
register_globalsincorrectly.
Create a page with this line in it: <? phpinfo() ?>, save
itwith a .php extension and load it up in your web browser. It
will, among amultitude of other things, have the correct value of
register_globals that youare using.
MantisBT now uses only .php files.If your webserver is
configured for other extensions (.PHP3, .PHTML) then youwill have
to have the administrator add support for .PHP files. This shouldbe
a trivial modification.Documentation can be found at:
http://www.php.net/manual/en/installation.php
Login to your bugtracker and go to the manage section.
Click on the projects link. You will need to ADD a new project. Then
EDIT the new project and remember to ADD at least one category.
Otherwise you won't be able to add any issues. That should be
it. You're off and running.
Requirements
The following versions are required for proper operation:
Package
Minimum Version
Tested with
MySQL
4.1.x
5.0.x
PostgreSQL (experimental)
7.0
8.0
PHP
5.2.x
5.2.x
Web Server
Apache 1.3.x, Apache 2.2.x, lighttpd 1.4.x, IIS 6.0
MantisBT is designed in a way to work in as many environments as possible.
Hence the required extensions are minimal and many of them are optional affecting
only one feature. The following PHP extensions are the ones used:
mysqli (or the extension for the DBMS being used) - mandatory.
Curl - if the Twitter integration feature is required.
GD - if the graphs feature is required.
fileinfo - Guesses the MIME type of attachments.
This extension is included by default from version 5.3.x
of PHP. For older versions of PHP you will need to install
the fileinfo PECL extension (this requires root access to
the server you're using). 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.
Backups
It is recommended to backup your MantisBT database on a
regular basis. This is easy to accomplish using the mysqldump
command:
mysqldump -u<username> -p<password> <database
name> > <output file>
To restore a backup you will need to have a clean database. Then
run:
mysql -u<username> -p<password> <database name>
< <input file>
You can also perform both of these tasks using
phpMyAdmin
A good idea is to make a backup script and run it regularly through
cron or a task scheduler (for Windows see
WinCron
).
Using the current date in the filename can prevent overwriting and
make cataloguing easier.
!!! Backups should always be performed before an upgrade !!!
Make sure to backup MantisBT code (which includes your configs +
possibly customization), issue attachments / project documents, and
database contents.
CVS Integration
CVS integration allows MantisBT to register commits to the CVS
source control system into corresponding issue notes in the issue
tracker. The setup requires that the MantisBT installation be
accessible on the computer running the CVS server. A copy of the
MantisBT config_inc.php file must be present.Note that the mysql
database also needs to be accessible from the cvs machine. That is,
"localhost" for $g_hostname won't work unless CVS and MantisBT are
hosted on the same machine.To activate the integration, the
following line to the cvs "commitinfo" file. (Instructions to edit
this file are in any number of CVS primers).
ALL /usr/bin/php /path_to_mantis/core/checkin.php
This will pass the commit message to checkin.php for all commits.
If the stringissue #nnnn is found in the commit message, the MantisBT
corresponding to "nnnn" will have the CVS commit message added as an
issue note to the issue. Multiple issues can be listed.This feature
is configured through config_inc.php and through custom
functions.
See also:
Source
Control Integration
for configuration, and
Custom
Functions
Uninstall
It is recommended that you make an backup in case you wish to use
your data in the future. See the
Backups
page for details.
To uninstall MantisBT:
Delete the MantisBT directory and all files and
subdirectories.
Drop all MantisBT tables from the database, these can be
identified by the configured prefix for the installation. The
default prefix is 'mantis'.
Remove any customizations or additions that you may have
made.
If you have the permissions to create/drop databases and you have a
specific database for MantisBT that does not contain any other data,
you can drop the whole database.