This documentation relates to 1.6.x
If you are using an earlier version, please view the previous versions of the Crucible documentation and select the relevant version.

On this page:


Running Crucible

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

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 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 here you will be asked for two things:

  1. An administrator password. This password controls access to the Administration screens.
  2. A license key. Please note your server ID. You can then get a Crucible evaluation license key here.

Accessing the Administration Pages

Once you have set up an administrator password (as described above), 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.

Setting Up a Perforce Repository in Stand-Alone Crucible

To set up Perforce in stand-alone Crucible,

  1. Ensure that the Perforce executable file is on the system path, in the Crucible server's Environment Variables
  2. Start Crucible then open the 'Admin' menu by clicking the Administration link in the footer of the page.
  3. Under the 'Repository Settings' heading, click 'Repository List' in the left-hand navigation bar.
  4. The 'Repository List' screen opens.
  5. Find the Perforce repository plugin and click its Configure Plugin link.
  6. The 'Configure Plugin' screen opens. Click 'Add Repository'.
  7. The 'Add Repository' screen opens. Fill in the fields.

    Field

    What to enter

    Name

    Choose a unique name for the repository.

    Repository Server

    Enter the base URL and port for the repository, for example:
    example.com:666.

    Repository Path

    Add the path to your Perforce repository. For example: //depot/code/example/main.

    Perforce Username

    Enter the username of the Perforce account that Crucible will use. (optional)
    (info) Note that this account should only have read-only access to the repository.

    Perforce Password

    Enter the password of the Perforce account that Crucible will use. (optional)


  8. Click 'Save'. The view will return to the list of repositories.
  9. Your Perforce repository is now set up for Crucible. You will be able to select changesets from it when creating reviews.

(info) There is no 'initial scanning' required in this process, as stand-alone Crucible's access to Perforce is strictly on-demand. Data is not indexed, hence there is no scanning.
(info) For those who may be interested, Crucible executes the Perforce command-line tool to enable this functionality.

Setting Up a Subversion Repository in Stand-Alone Crucible

To set up Subversion in stand-alone Crucible,

  1. Start Crucible then open the 'Admin' menu by clicking the Administration link in the footer of the page.
  2. Under the 'Repository Settings' heading, click 'Repository List' in the left-hand navigation bar.
  3. The 'Repository List' screen opens.
  4. Find the SVN repository plugin and click its Configure Plugin link.
  5. The 'Configure Plugin' screen opens. Click 'Add Repository'.
  6. The 'Add Repository' screen opens. Fill in the fields.

    Field

    What to enter

    Name

    Choose a unique name for the repository.

    Repository Root

    Enter the repository root URL for the repository. If you are not sure what the repository root is, please see the instructions below under "Finding your Repository Root".

    Repository Path

    Add the path on the base URL where your repository. For example, if you used the root URL above, and the full path to your Subversion instance is 'http://svn.example.com/svn5/', you would enter 'svn5' into this field.

    SVN Username

    Enter the username of the Subversion account that Crucible will use.
    (info) Note that this account should only have read-only access to the repository.

    SVN Password

    Enter the password of the Subversion account that Crucible will use.


  7. Click 'Save'. The view will return to the list of repositories.
  8. Your Subversion repository is now set up for Crucible. You will be able to select changesets from it when creating reviews.

(info) There is no 'initial scanning' required in this process, as stand-alone Crucible's access to Subversion is strictly on-demand. Data is not cached, hence scanning is not required.

Setting Up Reviewing of Confluence Pages in Crucible

To set up Confluence as a Code Repository in Crucible,
  1. Start Crucible then open the 'Admin' menu by clicking the Administration link in the footer of the page.
  2. Under the 'Repository Settings' heading, click 'Repository List' in the left-hand navigation bar.
  3. The 'Repository List' screen opens.
  4. Find the Confluence repository plugin and click its Configure Plugin link.
  5. The 'Configure Plugin' screen opens. Click 'Add Repository'.

  6. The 'Add Repository' screen opens. Fill in the fields.

    Field

    What to enter

    Name

    Choose a unique name for the repository.

    URL

    Enter the URL of your Confluence instance.

    Space Key

    You may optionally enter a space key here to restrict Crucible's view to that key only. If there are many spaces in your Confluence instance you will find that this improves performance. You can set up several Confluence repositories in Crucible, each using the same Confluence instance but covering a different Space.

  7. Click 'Save'. The view will return to the list of repositories.
  8. Now, access your Confluence instance. Open the 'Confluence Administration Console', then select 'Trusted Applications'. The Confluence 'Trusted Applications Details' dialog opens.
  9. In the 'Trusted Applications Details' dialog, enter the URL of your Crucible instance into the 'Name' field and click 'Send Request'. The 'Application Alias' will be automatically retrieved from Crucible. Save your changes.
  10. Confluence is now set up as a code repository for Crucible. You will be able to select your Confluence from the list of repositories, then select files from the Confluence wiki and add them to reviews.

Setting Up the File System as a Code Repository For Crucible

Error rendering macro 'excerpt-include'

No link could be created for 'Setting Up the File System as a Code Repository For Crucible'.

Setting Up a Repository via FishEye

(warning) This section requires a working FishEye installation as well as Crucible.

To use FishEye to access the source control repositories CVS, Subversion or Perforce for Crucible, see the FishEye documentation for how to add a repository.

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

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.

(info) We recommend you access the repository with a user that has only read access to the repository.

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:8060/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 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 on FishEye integration

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



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Blog and update.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.