This documentation relates to Crucible 2.7.x

If you are using an earlier version, please view the previous versions of the Crucible documentation and select the relevant version.
Skip to end of metadata
Comment: Corrected links that should have been relative instead of absolute.
Go to start of metadata

If you have been using FishEye and now want to move to Crucible, you can do this without losing your FishEye repositories.

(info) Read about how your Crucible installation works with FishEye.

On this page:

Before you Start

We strongly recommend you make a backup of your data before following the steps below. Refer to the documentation on making a backup.

Upgrade Procedure

  • Follow Method 1 if you have a default configuration and are not using a FISHEYE_INST directory (that is, your FishEye binaries and data are all stored under the same location, in the default FISHEYE_HOME directory).
  • Follow Method 2 below if you have FishEye configured to use a FISHEYE_INST directory (that is, your FishEye binaries are stored in the FISHEYE_HOME directory, separate from your FishEye data in the FISHEYE_INST directory).
  • Follow Method 3 if you are not using a FISHEYE_INST directory but would now like to start using one.

(info) Read more about the FISHEYE_INST environment variable.

Method 1 - Without a FISHEYE_INST Directory (default)
  1. Download Crucible.
  2. Extract the new Crucible archive into a directory such as /NEW_FISHEYE/.
  3. Delete the /NEW_FISHEYE/var directory.
  4. Shut down the old FishEye instance if it is running.
  5. Copy /OLD_FISHEYE/config.xml to /NEW_FISHEYE/.
  6. Copy the /OLD_FISHEYE/var directory to /NEW_FISHEYE/var.
  7. If you have a Cenqua-issued FishEye license, copy /OLD_FISHEYE/fisheye.license to /NEW_FISHEYE/. (Atlassian-issued licenses are included within config.xml.)
  8. Follow any version-specific instructions found in the Release Notes.
  9. Start Crucible from the new installation by running NEW_FISHEYE/bin/run.sh. (Use run.bat on Windows).
  10. Follow the initial configuration steps outlined below.
Method 2 - Using a FISHEYE_INST Directory
  1. Shutdown your existing fisheye server.
  2. Make a backup of your FISHEYE_INST directory.
  3. Download Crucible and unzip the archive into a folder. This document assumes you have extracted your Crucible zip file into a directory called /NEW_FISHEYE/.
  4. Leave your FISHEYE_INST environment variable set to its existing location.
  5. Start Crucible from the new installation by running NEW_FISHEYE/bin/run.sh. (Use run.bat on Windows).
  6. Follow the initial configuration steps outlined below.
Method 3 - Without a FISHEYE_INST Directory, but intending to set one up
  1. Shut down the old FishEye instance if it is running.
  2. Set up the FISHEYE_INST environment variable, then create the FISHEYE_INST directory on your filesystem.
  3. Copy the /OLD_FISHEYE/config.xml to /FISHEYE_INST.
  4. Copy the /OLD_FISHEYE/var directory to /FISHEYE_INST.
  5. Download Crucible.
  6. Extract the new Crucible archive into a directory such as /NEW_FISHEYE/.
  7. Start Crucible from the new installation by running NEW_FISHEYE/bin/run.sh. (Use run.bat on Windows).
  8. Follow the initial configuration steps outlined below.
  9. If you configuration is not automatically picked up and you cannot see your existing repositories, check your Administration > Sys-Info page, where you will see information about FISHEYE_HOME and FISHEYE_INST. Check your FISHEYE_INST is pointing to the right directory.

Initial Crucible Configuration

  1. You can access FishEye immediately by going to http://HOSTNAME:8060/ in a browser.
  2. The first time you run FishEye, enter your Crucible license key. To do this, update your Crucible license by opening 'Administration', then 'Sys-Info/Support'. On this screen, you can enter your Crucible license key. You can view your license key here. The Crucible functionality will be instantly unlocked.
  3. If you do not already have user accounts configured, you will need to do this via the Administration screens or by configuring Crucible/FishEye to use external authentication.
    To add users:
  4. 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.

4 Comments

Hide/Show Comments

  1. Jul 26, 2009

    Sherif Mansour

    If you are using Method (1) Above - can you ever delete the old FISHEYE_INST directory? It seems like for Method (1) you must keep your old Fisheye Installation directory + files for it to work. I just set it up using Method (1), but it means I can never delete my old fisheye instance.

    1. Jul 27, 2009

      Erik van Zijst [Atlassian]

      Hi Sherif,

      I'm afraid the instructions may be a bit confusing. Using method 1, just download and unzip your new version. Install it by unzipping in a directory. This location is what we refer to as FISHEYE_HOME. It contains just the product binaries, not your data. Your data lives your existing FISHEYE_INST directory. You do not need to make a copy of this directory.

      To start the new version, go to the bin/ directory and run the start.sh or start.bat script. Make sure your FISHEYE_INST environment variable is set and points to your existing data directory. Crucible will automatically upgrade your database and repositories to the data format of the new version.

      There is no reason to keep the old version around. You can safely delete it.

      N.B.
      Before you perform an upgrade, always make a backup first (following the standard instructions applicable for the version you are running).

      cheers,
      Erik

      1. Jul 27, 2009

        Sherif Mansour

        Thanks Erik - that makes more sence! Got it sorted.

  2. Dec 09, 2009

    Anonymous

    I think you both mean Method 2? Method 1 is with one without a FISHEYE_INST directory.