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

Skip to end of metadata
Go to start of metadata

Environment variables are system-wide settings that are required for certain applications.

Please note, that if you run FishEye as a Windows service, then any environment variables that you require must be set in your <FishEye home directory>/wrapper/conf/wrapper.conf file. See Running FishEye as a Windows service.

The environment variables used by FishEye are listed in the following table:

 

On this page:

Environment variableNotes
JAVA_HOME

Used by FishEye to select the Java Virtual Machine (JVM) to be used to run FishEye. If this environment variable is not set, FishEye will use whatever Java executable is available on the path. In Linux systems, this may sometimes be GCJ-based which causes some problems running FishEye.

See either Installing FishEye on Windows or Installing FishEye on Linux and Mac for instructions on setting JAVA_HOME.

If you're using the Java Service Wrapper to run Fisheye as a service on Windows, the wrapper will use the Java in your PATH instead of using JAVA_HOME. We recommend that JAVA_HOME should point to the Java executable in your PATH.

FISHEYE_OPTS

Used to pass parameters to the Java Virtual Machine (JVM) used to run FishEye. This is typically used to set the Java heap size available to FishEye (see Fix out of Memory Errors).

With a Sun JVM, for example, you would use:

FISHEYE_OPTS=-Xmx1024m -XX:MaxPermSize=128m

This would give FishEye a max of 1024 MByte heap, a Max permanent generation size of 128m. See Tuning FishEye performance for more information.

You can also use FISHEYE_OPTS to set various System Properties in FishEye. For example:

FISHEYE_OPTS=-Dname.of.property=value

After having set FISHEYE_OPTS and restarting your server, go to Administration > Sys Info/Support > System Info, and check your JVM Input Arguments to ensure that your server is picking up your FISHEYE_OPTS as expected.

FISHEYE_ARGSFISHEYE_ARGS are the arguments which will be passed to FishEye when it is started. You can set this to --debug, for example, or --debug-perf if you always want to have FishEye debugging put into the FishEye log files.
FISHEYE_LIBRARY_PATHUsed to tell FishEye where it should look to load any additional native libraries.
FISHEYE_INST

Used to tell FishEye where to store its data. It is recommended that you separate FishEye's data from its application files in <FishEye home directory> by using this variable. For example:

c:\path\to\fisheye_data   (no trailing backslash)

(info) Read more about using FISHEYE_INST in  either Installing FishEye on Windows or Installing FishEye on Linux and Mac.

Setting environment variables under Windows XP

(System environment variables are ignored if FishEye is run as a Windows service. Please refer to Running FishEye as a Windows service. )
(Linux instructions for setting environment variables are here .)

1. Click Start > Control Panel > System.

2. Click the Advanced tab.
3. Click the Environment Variables button.

4. Click New.
5. In the Variable name field, enter the name of the environment variable, for example:

FISHEYE_OPTS

6. In the Variable value field, enter the setting as required. This may be quite cryptic, for example the default value for FISHEYE_OPTS is this:

-Xmx256m


7. Restart the computer.

Setting environment variables under Linux or Mac

There are a number of ways to set environment variables on Linux or UNIX based systems (including Mac OS X). Here are just two:

For your current user:

1. Open up a shell or terminal window
2. Type this command:

vi ~/.profile 

(vi is a text editor, you can use another if desired)
3. Add this command:

export (variable name)=(variable value)

Where (variable name) and (variable value) are the environment variable elements. For example, if the environment variable you are setting is FISHEYE_OPTS, and the variable value is -Xmx256m, you would type the following:

export FISHEYE_OPTS=-Xmx256m

Add this command on its own line at the end of the file.
4. Save, and restart your shell.

For all users in the system:

1. Open up a shell or terminal window
2. vi /etc/profile (replace vi with your favourite text editor)
3. Add export (variable name)=(variable value) on its own line at the end of the file
4. Save, and restart your shell

If you are using a GUI, you may not need to open up the shell. Instead, you might be able to open the file directly in a graphical text editor.

(info) If you are experiencing memory errors in FishEye, see Fix Out of Memory errors.

1 Comment

  1. The instructions for Linux and Mac state to define FISHEYE_OPTS in the ~/.profile, but fisheyectl.sh does not honor it.  It simply defines the variable without including any existing value.  The only way to set options is to modify the shell script directly.