FishEye folder layout

By default, FishEye will create a self-contained instance directory within the <FishEye install 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 install directory> — they should be entirely separate locations. If you do put the  instance directory in the  <FishEye install 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.

Furthermore, we recommend that the instance directory be secured against unauthorized access.

On this page:

Default FishEye folder layout

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

<FishEye install directory>/config.xml

Configuration file.

<FishEye install directory>/var/

Directory under which FishEye stores its data.

<FishEye install directory>/var/data/

Persistent data.

<FishEye install directory>/var/cache/

Caches and indexes.

<FishEye install directory>/var/log/

Log files.

<FishEye install directory>/var/tmp/

Temporary files.

<FishEye install directory>/cache/

Caches and indexes. (and also in <FishEye install directory>/var/cache)

<FishEye install directory>/bin/

Scripts for controling FishEye.

<FishEye install directory>/lib/

FishEye's dependent libraries.

<FishEye install directory>/syntax/

Syntax highlighting definitions.

<FishEye install directory>/ ...

Remainder omitted for brevity.

Recommended FishEye folder layout

The FishEye folder layout that we recommend for production environments has the FishEye instance directory, which contains your instance data and is defined by FISHEYE_INST, in a completely separate location from the <FishEye install directory>.

$FISHEYE_INST/config.xml

Configuration file.

$FISHEYE_INST/var/

All persistent and most temporary data.

$FISHEYE_INST/cache/

Caches and indexes (and also in $FISHEYE_INST/var/cache)

$FISHEYE_INST/lib/

Site-specific Java libraries (.jars) that FishEye should load on startup. (Do not copy the dependent <FishEye install 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 using FISHEYE_OPTS, e.g.: export FISHEYE_OPTS=-Dpropname=value )

<FishEye install directory>/lib/

FishEye's dependent libraries.

<FishEye install directory>/syntax/

FishEye bundled highlighting definitions.

<FishEye install directory>/bin/

<FishEye install directory>/ ...

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

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport