Installing BugLogHQ

oarevalo edited this page Oct 11, 2014 · 10 revisions

Step 1: Install The BugLogHQ web app

To install BugLog just unpack the zip file into the root of your webserver. BugLogHQ assumes it will be installed on a directory named /bugLog. If you want, you can also put BugLog directly on the web root.

NOTE: If you want to install bugLog directly on the web root, make sure to update the setting general.externalURL to the value "/" so that BugLog knows how to find itself.

NOTE #2: Changing the setting general.externalURL in the main config you can tell BugLog the URL to use when referring to itself. By default buglog will try to guess it from the CGI scope, but in some cases you may want to override this. For example if you have a clustered deployment.

For a complete reference on all available configuration options see BugLogHQ Config Settings Reference

Step 2: Setup your Database

Run the corresponding SQL script for your database. The script can be found in the /install directory. This will create the necessary tables.

By default bugLogHQ uses a datasource named "bugLog" with no password, to change this go to:

/bugLog/config/buglog-config.xml.cfm

Change the <setting /> tags for:

db.dsn: datasource name as defined in the CF administrator (by default is bugLog)

db.dbtype: database type. Can be mysql, mssql (for Microsot SQL Server), pgsql (for PostgreSQL) or oracle. The default is mysql

db.username: username for the datasource (if needed)

db.password: password for the datasource (if needed)

Step 3: Open BugLogHQ on Your Browser

To access the bugLogHQ interface, go to /bugLog. The default username/password is:

username: admin
password: admin

IMPORTANT: To change the admin password or to create additional users click on the "Settings" link on the upper right corner of the screen.

Step 4: Verify That you can Receive Bug Reports

After installation use your browser to go to /bugLog/test and follow the links to test both the client and server side of BugLogHQ.

Step 5: Start Sending Bug Reports From Your Apps!

See the section on Using BugLogHQ to learn how to make your existing applications send its bug reports to your BugLogHQ instance.


CONFIGURING MULTIPLE ENVIRONMENTS

You can override any setting on the main config on a per-environment basis. To determine which is the current environment, BugLog will look for a file named severkey.txt on your /bugLog/config directory. This file should only contain a single word that is used to name the environment. For example: "dev" or "prod-server-1" or something like that.

Then on your buglog-config.xml.cfm add an <envSettings /> section like the following example:

<envSettings name="dev">
  <setting name="db.dsn">bugLog_dev</setting>
  <setting name="general.adminEmail">devteam@somedomain.org</setting>
</envSettings>

Where the "name" attribute of the envSettings tag must match what you provide on your serverkey.txt file. Inside you can place any number of <settings/> tags you want. These will override the settings of the same name defined on the general part of the config.

You can have as many <envSettings/> sections as you want. However only one will be used (the one that matches your serverkey.txt).

If none matches the serverkey, then BugLog will use the default settings.

An alternative way of providing the "serverkey" value is by using a Context Parameter. The advantage is that this method does not require you to add any new files to your BugLog installation. Of course, this only works if you have access to the config files of your application server.

For example in Tomcat, to set your serverkey as "dev", you would set a context parameter by editing "{Tomcat Path}/conf/context.xml" like this:

<Context>
  ...
  <Parameter name="serverkey" value="dev" override="false" />
  ...
</Context>

INSTALLING A NAMED INSTANCE

To create a new instance, just create a new directory under the webroot with the name you want for your neq instance (i.e. "/buglogdev").

On the new directory copy the contents of /bugLog/install/named-instance-template.

NOTE: don't copy the directory itself, only its contents.

Change the new Application.cfc to properly name your application, and modify the config/buglog-config.xml.cfm on your new instance to set its appropriate configuration (datasource, etc).

After that you can just go to /buglogdev (in this case) to access your new instance.

To submit bugs to this instance, just point your buglog client to /buglogdev/listener.cfm

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.