This page last changed on Nov 22, 2007 by rkrishna.
Read-only access for Crucible/FishEye

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

This document assumes you have extracted your Crucible zip file into a directory called /FISHEYE_HOME/.

Refer to our explanation of how Crucible works with FishEye.

Running Crucible

To run Crucible for the first time, simply do the following:

  • On Windows:
    C:\> cd FISHEYE_HOME\bin
    C:\FISHEYE_HOME\bin> run.bat
  • On Unix-based systems:
    $ cd /FISHEYE_HOME/bin
    $ ./run.sh

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

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 FishEye Administration screens, or by editing /FISHEYE_HOME/config.xml and restarting Crucible.

Supplying Administration Password and License Key

The first time you access the Crucible web server (http://HOSTNAME:8080/) you will see a screen like this, and here you will be asked for two things:

  1. An administrator password. This password controls access to the FishEye Administration screens.
  2. A license key. Please note your server ID. You can then get a Crucible evaluation license key here.
  • During evaluation, only a Crucible license is needed. Once you install a commercial Crucible license, a commercial FishEye license will be required.

Accessing the Administration Pages

Once you have set up an administrator password (as described above), you can access the Administration screens at http://HOSTNAME:8080/admin/.

One of your first steps will be to add a repository.

Setting Up a Repository

Once you have added a repository, you can view it through FishEye at http://HOSTNAME:8080/.

Building index and cache

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.

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

Setting Up 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:

  1. Open the FishEye Administration screens at http://HOSTNAME:8080/admin/.
  2. Click 'Users/Security' under 'Global Settings' in the 'Admin Menu'.

Read more details about the different ways of creating users.

Setting Up SMTP

Crucible can email each review participant on a range of changes. Each user can then set up their own preferences. This is described in the User Profile guide.

First, you must set up the SMTP Server.

Using Crucible

You can access Crucible/FishEye immediately by going to http://HOSTNAME:8080/ in a browser

Or you can go directly into the Crucible homepage at http://HOSTNAME:8080/cru

Stopping Crucible

To stop the Crucible server:

  • On Windows:
    C:\> cd FISHEYE_HOME\bin
    C:\FISHEYE_HOME\bin> stop.bat
  • On Unix-based systems:
    $ cd /FISHEYE_HOME/bin
    $ ./stop.sh

Document generated by Confluence on Nov 29, 2007 18:19