This page last changed on Jan 03, 2008 by edawson.

This guide describes the advanced FishEye installation options. For a quick install, see the Quick Start Guide.

  1. Download the FishEye zip file and extract it. This document assumes you have extracted FishEye to /FISHEYE_HOME/.
  2. Ensure you have installed an appropriate Java runtime - see System Requirements.
  3. Ensure that java is in the PATH, or that the JAVA_HOME environment variable is set.
  4. If you intend to use FishEye with Subversion, please ensure you read the System Requirements, Subversion client setup, and granting permission to FishEye to scan your repository.
  5. If you intend to use FishEye with Perforce, please ensure you read the Perforce client setup.
Read-only access for FishEye

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

FishEye Layout

By default, FishEye will run self-contained within the /FISHEYE_HOME/ directory. The FishEye directory layout looks like this:

/FISHEYE_HOME/config.xml Configuration file.
/FISHEYE_HOME/var/ Directory under which FishEye stores its data.
/FISHEYE_HOME/var/data/ Persistent information.
/FISHEYE_HOME/var/cache/ Caches and indexes.
/FISHEYE_HOME/var/log/ Log files.
/FISHEYE_HOME/var/tmp/ Temporary files.
/FISHEYE_HOME/bin/ Scripts for controling FishEye.
/FISHEYE_HOME/lib/ FishEye's dependent libraries.
/FISHEYE_HOME/ ... Remainder omitted for brevity.

However, this self-contained layout results in tedious copying of files each time you upgrade FishEye. Also, if you want to run multiple instances of FishEye, you need multiple /FISHEYE_HOME/ installations. These two issues can be avoided by setting a FISHEYE_INST ('FishEye Instance') location.

A separate FISHEYE_INST location is recommended for production installations of FishEye.

When the FISHEYE_INST environment variable is set, FishEye's directory layout becomes:

$FISHEYE_INST/config.xml
$FISHEYE_INST/var/ All permanent and temporary data is found under $FISHEYE_INST/var/
$FISHEYE_INST/lib/ Site-specific Java libraries (.jars) that FishEye should load on startup. (Do not copy the dependent /FISHEYE_HOME/lib/ files into here.)
$FISHEYE_INST/syntax/ Site-specific syntax highlighting definitions.
/FISHEYE_HOME/lib/ FishEye's dependent libraries.
/FISHEYE_HOME/syntax/ FishEye bundled highlighting definitions.
/FISHEYE_HOME/bin/
/FISHEYE_HOME/ ... Remaining files are found under /FISHEYE_HOME/.

The rest of this Installation Guide refers to $FISHEYE_INST/, but if you have not set FISHEYE_INST then it defaults to /FISHEYE_HOME/ (the directory where you extracted FishEye).

Next Step - Initial Configuration

See the guidelines on configuring FishEye.

Document generated by Confluence on Apr 14, 2008 23:36