Documentation for FishEye 2.9.x. Documentation for other versions is available too.

By default, FishEye will run a self-contained instance directory within the <FishEye home directory> – the directory where you unzip the package. The FishEye instance directory is where your FishEye data is stored. 

For a production environment, you should not locate your FishEye instance directory inside the <FishEye home directory> — they should be entirely separate locations. If you do put the  instance directory in the <FishEye home directory> it will be overwritten, and lost, when FishEye gets upgraded. And by the way, you'll need separate FishEye instance directories if you want to run multiple copies of FishEye. 

You should create your FishEye instance directory, and then tell FishEye where you created it by setting a FISHEYE_INST  environment variable. See Installing FishEye on Windows and Installing FishEye on Linux and Mac for information about setting the FISHEYE_INST  environment variable.

Default FishEye folder layout

The default FishEye folder layout includes the FishEye instance data inside the  <FishEye home directory>. This layout is not recommended for production environments.

<FishEye home directory>/config.xml

Configuration file.

<FishEye home directory>/var/

Directory under which FishEye stores its data.

<FishEye home directory>/var/data/

Persistent information.

<FishEye home directory>/var/cache/

Caches and indexes.

<FishEye home directory>/var/log/

Log files.

<FishEye home directory>/var/tmp/

Temporary files.

<FishEye home directory>/cache/

Caches and indexes. (in addition to FISHEYE_HOME/var/cache)

<FishEye home directory>/bin/

Scripts for controling FishEye.

<FishEye home directory>/lib/

FishEye's dependent libraries.

<FishEye home directory>/syntax/

Syntax highlighting definitions.

<FishEye home directory>/ ...

Remainder omitted for brevity.

 

Recommended FishEye folder layout

The FishEye folder layout recommended for production environments has the FishEye instance directory (as defined by FISHEYE_INST)  in a completely separate location from the <FishEye home directory>.

$FISHEYE_INST/config.xml

Configuration file.

$FISHEYE_INST/var/

All permanent and most temporary data is found under $FISHEYE_INST/var/

$FISHEYE_INST/cache/

Caches and indexes are found under $FISHEYE_INST/var/ (in addition to $FISHEYE_INST/var/cache)

$FISHEYE_INST/lib/

Site-specific Java libraries (.jars) that FishEye should load on startup. (Do not copy the dependent <FishEye home directory>/lib/ files into here.)

$FISHEYE_INST/syntax/

Site-specific syntax highlighting definitions.

$FISHEYE_INST/system.properties

Used for setting system properties within the FishEye JVM, which may sometimes be useful for support purposes.(Note: the other way to set properties is via FISHEYE_OPTS, e.g.: export FISHEYE_OPTS=-Dpropname=value )

<FishEye home directory>/lib/

FishEye's dependent libraries.

<FishEye home directory>/syntax/

FishEye bundled highlighting definitions.

<FishEye home directory>/bin/

 

<FishEye home directory>/ ...

Remaining files are found under <FishEye home directory>/.

  • ラベルなし


See answers from the community.


Raise an issue for our developers or tech writers.


Log a request with our support team.


Tweet, blog and update our documentation.

 Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.