The Bug Genie
The Bug Genie
star_faded.png
Please log in to subscribe to updates for this article
Category:The Bug Genie:User Guide:Setup
Last updated at Mon Sep 12 14:45, by kanto501

How do I set up the Bug Genie  ⇑ top

Once you have the Bug Genie installed it is time to set it up for how you will use it. First, you must log in as the Administrator. Once your logged in, use the pull down menu found by clicking the down arrow beside your log in name. You need to select the option "Configure The Bug Genie". This will open a configuration page with lots of options. We will try to explain each option on this page.

General Configuration  ⇑ top

Scopes  ⇑ top

View full size image
View full size imageicon_open_new.png
The Bug Genie scopes are self-contained environments within the same Bug Genie installation, set up to be initialized when The Bug Genie is accessed via different host names. The default scope (which is created during the first installation) is used for all host names when there is no other scope defined. To add another scope you need to click on the green plus sign found on the configuration page.

Settings  ⇑ top

General settings
View full size image
View full size imageicon_open_new.png
The General settings tab is full of small visual changes you can make to your system and all settings are self explanatory.










Appearance
View full size image
View full size imageicon_open_new.png
The appearance tab offers you the ability to change your theme, your heading and your Favicon. Oxygen is the only theme offered at the present time but there are some users who have been working on another theme.







Regional & language
View full size image
View full size imageicon_open_new.png
The Regional & Language tab is where we will select what language the Bug Genie uses, if we want to change the Character set from utf-8 and setting of the Bug Genie server time.




Users & Security
View full size image
View full size imageicon_open_new.png
The Users tab lets you do the following:
 1 Setup access for anonymous users and guest users. 
 2 Decide if you want to use Permissive or Restrictive permissions. 
 3 Decide to use Gravatar icons or default icons. 
 4 Decide if users can create their own accounts or only let the administrator create accounts.
 5 Create a whitelist of domains that can register on the system.
 6 Set what group is the default user group.
 7 Set the redirects for Log in and Log out.
 8 Set users status when  online, inactive, and offline.


Permissions  ⇑ top

View full size image
View full size imageicon_open_new.png
Permissions can be very complicated so more detailed information can be found here. There are 4 types of permissions, they are General, Page access, Project-specific, and Module specific.











Authentication  ⇑ top

View full size image
View full size imageicon_open_new.png
The Bug Genie has its own authentication system builtin. If your system uses LDAP then this would make sense as an authentication, so in version 3.14 an LDAP module was provided. Remember to setup the LDAP module first before making changes here.








 Additional information can be found here:
LDAP
LDAP Installation
LDAP Uninstall
LDAP Configuration
LDAP Technical Details


Uploads & Attachments  ⇑ top

View full size image
View full size imageicon_open_new.png
This section allows the following:
 1 Enable or disable file uploads.
 2 Set a maximum file size for uploaded files.
 3 Setup a file upload whitelist or blacklist. Common whitelist items are  txt,doc,jpg,png and
   common blacklist items are exe,bat,php,asp,jsp.
 4 Setup file store. The options you have are to store them in the database or store them in a 
   specified folder. If you choose to store them in a folder then you will need to specify the folder 
   location in the upload location field.


Import Data  ⇑ top

View full size image
View full size imageicon_open_new.png
This provides 3 ways or types of data for importing
CSV If you have some Bug Genie data you saved in a CSV file and you want to import it to your system you would do it here. For Example, you have some projects you want to import to a new setup of Bug Genie. In the What data would you like to import? section click on the Projects link. This opens up a window titled Import content from CSV. Follow the instructions on this window and do the "dry-run". If you get some errors you will need to fix them. Once the "Dry-run" is error free then just click off the "test the import" and select the "Import" button. You can find more information by going here. To import issues or clients the procedure is basically the same as projects. To help when you get errors on your "Dry-run" you will see a link titled "Toggle list of ID numbers". If you click this, it will display all the information you should need to fix your errors.

Bugs 1.x/The Bug Genie 2 If you have data from an older version of The Bug Genie then click this tab. Read the text and it will guide you through the long process of getting your data in to version 3.x. You will need to find other information from the wiki located here.

Sample Data If you want to experiment with a new instance of The Bug Genie 3.x then click this tab and select the "Import sample data" button. This will install a couple of sample projects using default settings


Projects  ⇑ top

View full size image
View full size imageicon_open_new.png
This is where you will create a new project. Creating a new project is very easy, just enter the name you want for the project in the "Create a new project" box and click the "Add" button. The new project should be created and displayed in the Existing projects section. For further editing of a project click here.






Issue Types  ⇑ top

View full size image
View full size imageicon_open_new.png
The Bug Genie comes with six standard issue types: Bug report, Feature request, Enhancement, Task, User story, and Idea. You can use any or all of these issue types for your projects or you can create your own issue type.(how to create an issue type can be found here.






View full size image
View full size imageicon_open_new.png
You must use an Issue Type Scheme to attach issue types to projects, a default issue type scheme is provided. You may use the default scheme but if you need a different scheme you should make a copy of the default and edit. How to set up an issue type scheme is found here.




Issue Fields  ⇑ top

View full size image
View full size imageicon_open_new.png
The Bug Genie provides 6 built-in issue fields: Status, Resolution, Priority, Severity, Categories, and Reproducibility. You may use any of these six or create your own custom issue field.



How to create a custom issue field can be found here. If you need to you can also edit the built-in issue fields options by adding a new option or deleting an option. How to modify a built-in issue field can be found here.


Workflow  ⇑ top

View full size image
View full size imageicon_open_new.png
Workflow in an important piece of the system, allowing you to control the process of work from identifying the bug, feature, etc to the finish of the installed software that addresses it. A default workflow is provided but if you need to make changes you will have to make a copy of the default and edit the copy.





View full size image
View full size imageicon_open_new.png
How to create a copy of the default workflow and edit it can be found here. Just like Issue Types has a scheme, the workflow has a workflow scheme. The workflow scheme allows you to assign different workflows to any of the Issue Types for a project. The default workflow scheme is not editable so you might need to make a copy of it and edit the copy.



How to edit a workflow scheme can be found here.

Users, Teams, Clients & Groups  ⇑ top

Users
View full size image
View full size imageicon_open_new.png
The Users tab is where you can either find a user or add a new user. To find a user just enter the user's name in the Find user(s) box and click on the "Find" button. The user (if found) will display. If your not sure of the user name but know it starts with say "th" then just enter th in the Find user(s) box and click on the "Find" button, all users starting with th will display. To add a user just enter the username you want to add in the Enter username box and click on the "Create user" button. The user will be displayed with the ID, Username, Real name. and Actv set.
Groups
View full size image
View full size imageicon_open_new.png
The Groups tab has 3 standard groups and the ability to add new groups if you desire. There are 2 ways to create new groups. The first is the enter the group's name in the "Create a new group" box and click the "Create" button. The second way to create a group is by clicking on the icon with a plus sign(+) of one of the standard groups and it will create a clone of that group. So why would you want to clone a group? The reason is simple, this clone has all the permissions of the group it was cloned from, making it much easier to setup.


Teams
View full size image
View full size imageicon_open_new.png
The Teams tab has 5 standard teams and the ability to add new teams if you desire. Just like the Groups there are 2 ways to create new teams and it's process is the same as Groups. So you can read the Groups section for how to create or clone a team.




Clients
View full size image
View full size imageicon_open_new.png
The Clients tab is where you will add all users/clients of your product.




Modules  ⇑ top

View full size image
View full size imageicon_open_new.png
The Modules section is where you enable, disable, or configure modules. The current list of modules are Email communication, VCS Integration, Wiki, and LDAP Authentication.










Email Communication  ⇑ top

View full size image
View full size imageicon_open_new.png
The Email Communication section is where you configure email for the Bug Genie. It sets up the following options:
 1 Enable/disable outgoing email notifications.
 2 Specify the email from name. The default is "The Bug Genie Automailer".
 3 Specify the email from address. An example would be something like buggenie@website.com
 4 Enable/disable the sendmail -f option. Some systems might not like this option on.
 5 Set the email header character set. The default is utf-8.
 6 Set email to either send email notifications instantly or use an email queuing.
 7 Set if you want to use the builtin php email configuration settings or use a custom configuration.
At the bottom of the page is a Send test email box. To test you have everything configured correctly just enter your email address in the box and click the "Send test email" button. Additional information can be found here:
Mail
Delayed Mailings


Wiki  ⇑ top

The Wiki section is where you configure your wiki.
General wiki settings
View full size image
View full size imageicon_open_new.png
On this tab you can do the following:
 1 Change the wiki menu title. The default is Project wiki/wiki
 2 Enable/disable CamelCase links. If you do not know what CamelCasing is look here
 3 Enable/disable Wiki links. The default is enabled so the links are visible.
 4 Set permissions for wiki editing. The options are:
 * Open for everyone with access to add/remove content
 * Only registered users can add/remove content
 * Set wiki permissions manually

Import wiki articles
View full size image
View full size imageicon_open_new.png
The Import wiki articles tab provides a quick way for you to import wiki articles that com with a release but are not automatically loaded in to the wiki. This tab allows you to import just certain files by selecting them individually or you can use the pull down menu for showing just the articles for a particular category. The default view for this tab is to show all articles.

This category doesn't have any subcategories

There are no pages in this category

Article attachments

Article comments (0)

There are no comments