Crucible 2.7 : Configuring Crucible

This page describes the initial configuration of Crucible, including the steps contained in the Crucible setup wizard.

Running Crucible

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

To run Crucible for the first time:

  • 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 8060. You can access Crucible immediately by going to http://HOSTNAME:8060/ in a browser.

By default, Crucible will listen on port 8060 for HTTP requests. It also listens on 127.0.0.1:8059 as a control port. You can configure both of these in the 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:8060/) you will see a screen like this and you will be asked for two things:

  • An administrator password. This password controls access to the administration screens.
  • A license key. Please note your server ID, shown on the screen above. You can then get a Crucible evaluation license key from the Atlassian website.

Integrating Crucible with JIRA

You can connect your application to a JIRA server, to manage your users via JIRA and share information with JIRA. When you are installing the application, the setup wizard gives you the opportunity to configure the JIRA connection automatically. This is a quick way of setting up your JIRA integration with the most common options.

You can also configure the JIRA connections via the application administration screens. In that case, you will need to set up connections individually. There are two parts to the integration process:

  • A peer-to-peer link between JIRA and the application for sharing information and facilitating integration features. This link is set up via Application Links.
  • A client-server link between the application and JIRA for delegating user and group management to your JIRA server.

Requirements: You need JIRA 4.3 or later.

For detailed instructions and troubleshooting, see Configuring JIRA Integration in the Setup Wizard.

Accessing the Administration Pages

Once you have set up an administrator password, you can access the administration screens at http://HOSTNAME:8060/admin/.

One of your first steps will be to set up access to a source-control repository, or an alternative form of code storage such as the local file system or Atlassian Confluence.

The instructions for configuring your repositories are different, depending on your Crucible setup:

Setting Up Users

On initial setup of Crucible, you can choose to integrate your user base with JIRA, as described above. If you do that, the setup process will copy across your JIRA users into Crucible.

If you do not integrate with JIRA in the setup process, Crucible will not have any users defined after setup.

Adding user accounts is done via the administration screens or by configuring Crucible/FishEye to use external authentication.

To add users:

  1. Open the Crucible administration screen at http://HOSTNAME:8060/admin/.
  2. Click 'Users/Security' under 'Global Settings' in the 'Admin Menu'.

Read more details about the different ways of creating users in the FishEye documentation.

Understanding Notifications and Setting Up Your Mail Server

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 guide to the user profile guide.

First, you must set up the SMTP Server.

Using Crucible

You can access Crucible immediately by going to http://HOSTNAME:8060/ in a browser.

Or you can go directly into the Crucible homepage at http://HOSTNAME:8060/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

Information about FishEye Integration with Crucible

If you want to know more about how Crucible and FishEye interact, refer to our explanation of how Crucible works with FishEye.