Home | Clover | Clover.NET | FishEye | Crucible | Support | Account | Download | Buy Now

Install Guide

This guide explains how to get Crucible installed and running as easily as possible. Many references are made to the FishEye documentation.

Note
/CRUCIBLE_HOME/may be referenced as /FISHEYE_HOME/ in the FishEye documentation.

Install Crucible

  1. Download the Crucible zip file and extract it. This document assumes you have extracted Crucible to /CRUCIBLE_HOME/.
  2. Ensure you have installed an appropriate Java runtime, see Requirements. Ensure that java is in the PATH, or that the JAVA_HOME environment variable is set.
  3. If you intend to use Crucible/FishEye with Subversion, please ensure you read about the Requirements, Subversion Client setup, and granting permission to FishEye to scan your repository.
  4. If you intend to use Crucible/FishEye with Perforce, please ensure you read about the Requirements and Perforce Client setup.
  5. Copy your crucible.license file to /CRUCIBLE_HOME/. You can download a trial license here.

Run Crucible

Note
We recommend you run Crucible/FishEye as a user that has only read access to your repository.

You can start Crucible immediately with the following:

$ cd /CRUCIBLE_HOME/bin
$ ./run.sh

(Use run.bat on Windows)

Once started, Crucible will run its own HTTP webserver on port 8080. You can access Crucible immediately by going to http://HOSTNAME:8080/ in a browser.

Note
By default, Crucible will listen on port 8080 for HTTP requests. It also listens on 127.0.0.1:8079 as a control port. You can configure both of these in the Administration screens, or by editing /CRUCIBLE_HOME/config.xml and restarting Crucible.

Setup Crucible

Setup Repository

The first time you access Crucible from a browser, you will be required to enter an administrator password. This password will give you access to the FishEye Admininistration screens.

Once you have setup an administrator password, you can access the Administration screens at http://HOSTNAME:8080/admin/. One of the first steps will be to add a repository.

Once you have added a repository, you can view it through FishEye at http://HOSTNAME:8080/. FishEye needs to build an index and cache of the contents of your repository, so some information will not appear in FishEye until this is complete.

Note
This may take some time to complete depending on the size of the repositories.

Setup Users

On initial setup of Crucible, there are no users. Adding user accounts is done via the Administration screens or by configuring Crucible/FishEye to use external authentication.

To add users, you can access the Administration screen at http://HOSTNAME:8080/admin/ and then go to Global Settings | Users/Security. Details about the different ways of creating users can be found here

Setup SMTP

Crucible can email each review participant on a range of changes, each user can then setup their own preferences, this is described in the User Profile guide. In the meantime the SMTP Server needs to be setup.

Using Crucible

You can access Crucible/FishEye immediately by going to http://HOSTNAME:8080/ in a browser or to go directly into the Crucible homepage go to: http://HOSTNAME:8080/cru

Stopping Crucible

Use stop.sh (or stop.bat on Windows) to stop the Crucible server:

$ cd /CRUCIBLE_HOME/bin
$ ./stop.sh