This page last changed on Feb 19, 2008 by edawson.

A FishEye instance can be managed using the fisheyectl script. Before running this script you need to ensure that you have set the JAVA_HOME environment variable, or that java is on the path.

Unix usage:

/FISHEYE_HOME/bin/fisheyectl.sh _command \[options\]_

Windows usage:

\FISHEYE_HOME\bin\fisheyectl.bat _command \[options\]_

The command parameter can be one of run, start or stop (see below). You can also find convenience scripts for running each of these commands, such as run.sh or run.bat.

run

The run command starts FishEye. This command runs FishEye in the foreground. It does not fork a background process.

Options:

--config path Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.
--quiet Do not print anything to the console.
--debug Print extra information to the debug log.
--debug-perf Print performance-related information to the debug log.

The following options are currently available, but will be removed at a later date:

--Xtab-width nchars Specifies the number of spaces to use to represent a tab character. The default is 8.
--Xdisable-dirtree-empty-checks When rendering the directory tree on some pages, FishEye calculates if each directory subtree is empty. For massive repositories, this calculation can cause the page to take a long time to render. This option disables the calculation that determines emptiness.
--Xdisable-content-indexing Disable the generation of a full-text index for file content. This prevents urther indexing, but does not delete any existing full-text indexes. FishEye will not warn you if you specify this option but still try to do a content search. This option is useful if you do not use content search and you are finding FishEye is taking a long time to index your content.

start

The start command has the same options as run, but starts FishEye in the background.

Windows: FishEye will be run in a separate cmd.exe window.

Unix: FishEye will be run with nohup and the console output will be redirected to $FISHEYE_INST/var/log/fisheye.out.

stop

The stop command stops a running FishEye instance.

Options:

--config path Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.

fullscan

Usage:

fisheyectl fullscan _\[options\] \[repname ...\]_

The fullscan command requests a full scan of the given repositories, or all repositories if no repository name is given

Options:

--config path Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.

rescan

Usage:

fisheyectl rescan _\[options\] repname start end{_}

Requests a rescan of the given repository between two specified revision ids.

Note: this operation is not supported by CVS or Perforce repositories.

Options:

--config path Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.

reindex

Usage:

fisheyectl reindex _\[options\] \[repname ...\]_

Requests a full reindex of the given repositories, or all repositories if no repository name is given.

Options:

--config path Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.

 

backup

Usage:

fisheyectl backup _\[filename\]_

The backup command creates a zip archive containing important FishEye configuration files.

Options:

filename Store the backup.zip to filename. Default is $FISHEYE_INST/backup/backup_yyyyddMMHHmmss.zip.
Document generated by Confluence on Apr 14, 2008 23:36