FishEye Quick Start Guide

This guide will explain how to get FishEye installed and running as easily as possible. For more advanced installation topics, see the Installation Guide.

Step 1. Install FishEye

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 Supported Platforms. Ensure that java is in the PATH, or that the JAVA_HOME environment variable is set.
3. If you intend to use FishEye with Subversion, please be sure to read about the Supported Platforms, Subversion client setup, and granting permission to FishEye to scan your repository.
4. If you intend to use FishEye with Perforce, please ensure you read about the Supported Platforms and Perforce client setup.

Step 2. Run FishEye

1. You can start FishEye immediately with the following:
   • For Unix-based systems:

     $ cd /FISHEYE_HOME/bin
     $ ./run.sh
     

   • For Windows-based systems:

     C:\> cd FISHEYE_HOME\bin
     C:\FISHEYE_HOME\bin> run.bat
     

2. Once started, FishEye will run its own HTTP web server on port 8060. You can access FishEye immediately by going to http://HOSTNAME:8060/ in a browser.

   Default ports

   By default, FishEye 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 FishEye Administration pages or by editing /FISHEYE_HOME/config.xml and restarting FishEye.

   Read-only access for FishEye

   We recommend you run FishEye as a user that has only read access to your repository.
   
   An exception to this rule is users running the JIRA FishEye plugin with Perforce Job Integration. In that scenario, you must give FishEye write access.

Step 3. Set up FishEye

1. The first time you access FishEye from a browser, you will be asked to enter an administrator password. This password will give you access to the FishEye Administration pages.
2. You will also be prompted for a trial license, which you can find here.
3. Once you have set up an administrator password, you can access the Administration pages at http://HOSTNAME:8060/admin/.
4. One of the first steps will be to add a repository.

Step 4. Use FishEye

1. Once you have added a repository, you can view it in FishEye at http://HOSTNAME:8060/.
2. 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.

Stopping FishEye

To stop the FishEye server:

• For Unix-based systems:

  $ cd /FISHEYE_HOME/bin
  $ ./stop.sh
  

• For Windows-based systems:

  C:\> cd FISHEYE_HOME\bin
  C:\FISHEYE_HOME\bin> stop.bat
  

Want a hands-on tour of the best FishEye features? See the FishEye 101 page.