If you have been using FishEye and now want to move to Crucible, you can do this without losing your FishEye repositories.
Before you startWe 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>
). This is the typical scenario for evaluation installations.
- 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 directory with a location defined byFISHEYE_INST
). This is the recommended scenario for production installations.
- Follow Method 3 if you are not using a
FISHEYE_INST
directory but would now like to start using one. You may wish to do this when configuring an existing installation for a production environment.
Read more about the
FISHEYE_INST
environment variable.
Method 1: Without a FISHEYE_INST Directory (default)
- Download Crucible.
- Extract the new Crucible archive into a directory such as
<New FishEye directory>
- Shut down the old FishEye instance if it is running.
- Copy
<FishEye home directory>
/config.xml<New FishEye directory>
- Delete the
<New FishEye directory>
- Copy the
<FishEye home directory>
/var<New FishEye directory>/
- Follow any version-specific instructions found in the Release Notes.
- Start Crucible from the new installation by running
<New FishEye directory>
/bin/run.shrun.bat
on Windows). - Follow the initial configuration steps outlined below.
Method 2: Using a FISHEYE_INST Directory
- Shutdown your existing fisheye server.
- Make a backup of your FISHEYE_INST directory.
- 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 directory>
- Leave your
FISHEYE_INST
environment variable set to its existing location. Crucible will use this variable. - Start Crucible from the new installation by running
<New FishEye directory>
run.bat
on Windows). - Follow the initial configuration steps outlined below.
Method 3: Without a FISHEYE_INST Directory, but intending to set one up
- Shut down the old FishEye instance if it is running.
- Set up the
FISHEYE_INST
environment variable, then create theFISHEYE_INST
directory on your filesystem. - Copy the
<FishEye home directory>
FISHEYE_INST
- Copy the
<FishEye home directory>
FISHEYE_INST
- Download Crucible.
- Extract the new Crucible archive into a directory such as
<New FishEye directory>
- Start Crucible from the new installation by running
<New FishEye directory>
run.bat
on Windows). - Follow the initial configuration steps outlined below.
- 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 the
<New FishEye directory>
FISHEYE_INST
. Check thatFISHEYE_INST
is pointing to the correct directory.
Initial Crucible configuration
- You can access FishEye immediately by going to
http://HOSTNAME:8060/
in a browser. - 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.
- 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:- Open the FishEye Administration screens at
http://HOSTNAME:8060/admin/
. - Click 'Users/Security' under 'Global Settings' in the 'Admin Menu'.
Read more details about the different ways of creating users.
- Open the FishEye Administration screens at
- 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.