Installation
This guide details the advanced installation options that can be used when installing Fisheye. For a quick install see the quickstart guide
FishEye Prerequisites
- Download the FishEye zip file and extract it. This document assumes you have extracted FishEye to /FISHEYE_HOME/.
- Ensure you have installed an appropriate Java runtime, see Requirements. Ensure that java is in the PATH, or that the JAVA_HOME environment variable is set.
- If you intend to use FishEye with Subversion, please ensure you read about the Requirements, Subversion Client setup, and granting permission to FishEye to scan your repository.
- Obtain your fisheye.license file. You can download a trial license here.
- Note: 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/fisheye.license | FishEye license. |
| /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 dependant 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.
When the FISHEYE_INST environment variable is set, FishEye's directory layout becomes:
| $FISHEYE_INST/config.xml | |
| $FISHEYE_INST/fisheye.license | |
| $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 dependant /FISHEYE_HOME/lib/ files into here.) |
| /FISHEYE_HOME/lib/ | FishEye's dependant libraries. |
| /FISHEYE_HOME/bin/ | |
| /FISHEYE_HOME/ ... | Remaining files are found under /FISHEYE_HOME/. |
The rest of this document will refer to $FISHEYE_INST/, but if you have not set FISHEYE_INST then it defaults to /FISHEYE_HOME/ (the directory where you extracted FishEye).
Initial configuration
FishEye runs its own HTTP webserver, and additionally listens on a socket for administration/shutdown commands. These default to :8080 and 127.0.0.1:8079, respectively. You can change both these addresses before starting FishEye by editing config.xml.
The first time you run FishEye, when you access the FishEye webserver you will be asked to enter an administrator password. This password controls access to the FishEye administration pages.
You can disable FishEye's administration pages by setting admin-hash="" in the <config> element of config.xml before starting FishEye.
If you need to reset the administrator password, delete the admin-hash attribute in the <config> element. You will be prompted to enter a administrator password next time you start FishEye.
To run FishEye for the first time, simply do the following:
$ cd /FISHEYE_HOME/ $ ./run.sh
(Use run.bat on Windows)
Further Configuration
Once started, FishEye will run its own HTTP webserver (by default on port 8080). You can access FishEye immediately by going to http://HOSTNAME:8080/ in a browser.
Once you have setup an administrator password, you can access the admin pages at http://HOSTNAME:8080/admin/. One of the first steps will be to add a repository.
You will also want to read about the command line scripts for controling FishEye.