Installing or upgrading The Bug Genie  

Fresh install  

System requirements  

To be installed, The Bug Genie requires the following:

• A web server, with URL rewriting capabilities
• PHP version 5.3.0 or later. PHP version 5.2.x is not supported.
• A supported database (!MySQL >= 5.0 or !PostgreSQL >= 8.2 ) and php modules for this database
• For statistics, the php-gd library needs to be installed

Installing  

After unpacking the archive into a folder, access the thebuggenie/index.php file, and the installation wizard should start automatically. This will also guide you through and explain setting up the rewrite rules.

Upgrading  

Version 3.1 -> 3.1.x  

To upgrade from 3.1 to the latest 3.1.x version, download the archive from the main download site. Extract the files into your current installation, overwriting existing files where prompted. When this is done, clear the contents of the B2DB cache folder (don't delete the folder, just its contents):

 core/cache/B2DB

Version 3.0.1 -> 3.1 or 3.1.x  

To upgrade from 3.0.1 to 3.1 / 3.1.x, download the archive from the main download site. Extract the files into your current installation, overwriting existing files where prompted. When this is done, clear the contents of the B2DB cache folder (don't delete the folder, just its contents):

 core/cache/B2DB

The upgrade helper needs write access to the following two files:

 ./installed #This file will be altered with version information
 ./upgrade #This file will be deleted

The last file doesn't exist. Create it to enable upgrading, and then open up the your bug tracker with the following url, which will launch the upgrade helper:

 <trackername>/upgrade

When the upgrade helper is completed, your installation will be upgraded to version 3.1

Version 3.0 -> 3.0.1  

To upgrade from 3.0 to 3.0.1, download the archive from the main download site. Extract the files into your current installation, overwriting existing files where prompted. When this is done, clear the contents of the B2DB cache folder (don't delete the folder, just its contents):

 core/cache/B2DB

Upgrading from ANY pre-release / beta / RC version -> ANY other version  

We do not support upgrading from pre-release, beta or RC versions. Please perform a clean install of the latest stable release, or perform an upgrade from an earlier stable release if available.

Troubleshooting  

Required database permissions for installing and using The Bug Genie?  

The Bug Genie does not require any special database permission for normal usage, except the following:

 SELECT, UPDATE, INSERT, DELETE

During installation, however, tables are created, and as such the database user used during installation also requires the following permissions:

 CREATE, ALTER, INDEX

If you want to change the database user used in normal operations, after the installation has been completed, you can do so by updating the username located in the following file:

 core/b2db_bootstrap.inc.php

What files should I back up when upgrading or reinstalling The Bug Genie?  

A general overview of the folder structure of The Bug Genie is available in the development section in the wiki. Worth noting is that The Bug Genie stores configuration and installation information in the following files (from project root):

 /installed
 /core/b2db_bootstrap.inc.php

/installed
This file contains version information and timestamp from when the installation took place. The file is required for The Bug Genie to run, as it is being pinged everytime The Bug Genie is initialized. The file usually contains something like this:

 3.0, installed 29.04.2011 21:45

After upgrade, it will contain something like this:

 3.1, upgraded 30.04.2011 20:11
 3.0, installed 29.04.2011 21:45

/core/b2db_bootstrap.inc.php
This file contains the database connection details. Contents usually looks like this:

<?php
        /**
         * B2DB sql parameters
         *
         * @author Daniel Andre Eikeland <zegenie@zegeniestudios.net>
         * @version 2.0
         * @license http://www.opensource.org/licenses/mozilla1.1.php Mozilla Public License 1.1 (MPL 1.1)
         * @package B2DB
         * @subpackage core
         */

        self::setUname('db_user');
        self::setPasswd('password');
        self::setTablePrefix('tbg3_');

        self::setDSN('mysql:host=localhost;dbname=thebuggenie_db');

In addition, the apache .htaccess file is located inside the public directory:

 thebuggenie/.htaccess

For a minor performance increase you can copy this configuration to your virtual host configuration if you're using apache.

Installing The Bug Genie on IIS6  

The Bug Genie requires url rewriting to function. You will be able to install it without, but you will not be able to use The Bug Genie without an url rewriting module properly configured for The Bug Genie. There is a free rewrite module available from microsoft's codeplex: http://iirf.codeplex.com/ and there is also one available from a company called helicontech: http://www.helicontech.com/isapi_rewrite/

Tips and tricks about installing The Bug Genie on IIS6 can be found in this forum thread:
http://www.thebuggenie.com/forum/viewtopic.php?f=5&t=646

Error: date(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function.  

The Bug Genie requires php to be correctly configured - this includes configuring the default timezone. As The Bug Genie supports multiple timezones including server / user difference, this is a requirement for The Bug Genie to function properly. Please see the php documentation for how to set this up properly: http://www.php.net/manual/en/datetime.configuration.php#ini.date.timezone

Error: preg_match() function.preg-match: Compilation failed: unrecognized character after (?< at offset  

The Bug Genie requires pcre libraries version 8 or later. This message usually occurs if the pcre libraries on your system is older than the required version. (On many !CentOS and !RedHat systems, the installed libraries are version 6.x) You can find your installed pcre library version by looking at the pcre section of your

<?php
 phpinfo();

To fix this error you need to upgrade your system pcre libraries to a new version, at least version 8.

Note: as of 3.1, a check is performed during installation to make sure your pcre libraries are up to date. Installation will not be possible with pcre libraries < version 8.

What is the default username and password?  

The Bug Genie sets up one administrator and one (automatic) guest user. The Administrator user has the following username/password:

• Username: administrator
• Password: admin

It is recommended that you change this immediately after logging in for the first time, to avoid unwanted access. Remember that the initially created administrator user has all the necessary permissions to perform common tasks, such as configuring The Bug Genie, adding users, teams, groups, projects, etc.

Where can I download the latest version?  

The latest stable version is always available from http://www.thebuggenie.com/get.
For details on accessing our developer version via the git repositories, see the Developer's Guide getting started guide.