This documentation relates to an earlier version of FishEye.
View

Unknown macro: {spacejump}

or visit the current documentation home.

FishEye can be run as a service under Microsoft Windows.
To run FishEye as a service you can either use SRVANY and INSTSRV to run java.exe or create a Java Service Wrapper. A mechanism to run FishEye as a service will be incorporated at a later stage. In the meantime, example wrapper files written by FishEye users can be found here.

To install on Windows:

  1. Unzip the wrapper zip file into your FISHEYE_HOME directory (Note, the end structure should be FISHEYE_HOME/wrapper, FISHEYE_HOME/wrapper/bin, etc and NOT FISHEYE_HOME/wrapper/wrapper, FISHEYE_HOME/wrapper/wrapper/bin. The location of the wrapper directory is important).
  2. Run Fisheye-Install-NTService.bat, found in FISHEYE_HOME/wrapper/bin.
  3. Start the Fisheye service under the Windows Control Panel.
  4. Set your FISHEYE_INST within your FISHEYE_HOME/wrapper/conf/wrapper.conf as per the instructions below:

Please note, that if you do run as a service, then any Environment Variables that you want to set, need to be set in your FISHEYE_HOME/wrapper/conf/wrapper.conf file.

If there are other java parameters you wish to add, then you will need to add them under the additional parameters, e.g.

# JDK 1.5 Additional Parameters for jmx
wrapper.java.additional.4=-Dcom.sun.management.jmxremote
wrapper.java.additional.5=-Dcom.sun.management.jmxremote.port=4242
wrapper.java.additional.6=-Dcom.sun.management.jmxremote.authenticate=false
wrapper.java.additional.7=-Dcom.sun.management.jmxremote.ssl=false
wrapper.java.additional.8=-Dcom.sun.management.jmxremote.authenticate=false
wrapper.java.additional.9=-Dcom.sun.management.jmxremote.password.file=./wrapper/jmxremote.password
wrapper.java.additional.10=-Dwrapper.mbean.name="wrapper:type=Java Service Wrapper Control"

For example if you wish to add a FISHEYE_INST environment variable or add the java parameter "MaxPermSize", or the -Xrs options (should be used if running FishEye as a service under Windows, to prevent the JVM closing when an interactive user logs out) then it would be something like:

wrapper.java.additional.11=-Dfisheye.inst="c:/path/to/FISHEYE_INST"
wrapper.java.additional.12=-XX:MaxPermSize=128m
wrapper.java.additional.13=-Xrs

Your memory settings can also be found in this file:

# Initial Java Heap Size (in MB)
wrapper.java.initmemory=32

# Maximum Java Heap Size (in MB)
wrapper.java.maxmemory=256

Increase these values if you have a large repository or expect to use more memory (init of 256, and a max of 1024 would be reasonable).

Wrapper Configuration and "-server" Parameter

Please note that the Wrapper configuration provided above uses the -server parameter to enable the Java HotSpotTM Server VM. This feature is only available if you use the JDK. If you use the JRE you will likely get the following error in your logs:

INFO | jvm 1 | 2010/12/20 18:19:28 | Error: no `server' JVM at `C:\Program Files\Java\jre6\bin\server\jvm.dll'.

A common issue is that customers remove the -server parameter from the wrapper.conf file. Please note that if you do this, the Wrapper script will ignore any of the following JVM parameters unless you change the sequence to start at wrapper.java.additional.1. This is an issue with the Wrapper application.

In this situation it's likely best to install and run Fisheye/Crucible with the JDK to get all the advantages of the -server functionality.

  • No labels