This documentation relates to an earlier version of FishEye.
View

Unknown macro: {spacejump}

or visit the current documentation home.

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.

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.

Options (for both run and start):

--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.

If you start FishEye with this flag, then empty directories will no longer show up as grey (i.e. deleted) and the option to hide them will also disappear

--Xdisable-content-indexing

Disable the generation of a full-text index for file content. This prevents further 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.

--Xenable-git-content-hash-resolving-heuristicWhen several git revisions have the same hash (for instance if changes have been reverted and then reapplied) just use the most recent revision. This may perform better, but may show incorrect revision numbers in File tab of the repository browser.

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 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.

scannow

The scannow command requests an incremental scan from the command line.

Usage:

fisheyectl scannow -s [repname ...]

Options:

-s

Run synchronously; i.e. the command will not terminate until the requested indexing operation is complete.

  • You can set the poll period to 'Never' in which case the repo will be viewable from the web UI but the repository will not be polled.
  • Repositories may be polled in the demand using this code:

    fisheyectl.sh scannow [repname ...]

    This will perform a one-time indexing operation.
    Note: scannow can also be used on a repository which has a poll period.

backup

Usage:

fisheyectl backup -f [filename]

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

Options:

-f filename

Store the backup.zip to filename. Default is $FISHEYE_INST/backup/backup_yyyyddMMHHmmss.zip.

11 Comments

  1. Bryce Schober

    I just upgraded our installation from 1.2.something to 1.6.latest, and my tab-width override in the service wrapper stopped working. Did the syntax change? Did it get dropped (as warned) without the docs being updated? Is there some other way to set the default anonymous-access tab width? I currently have inserted in my wrapper.conf:

    wrapper.app.parameter.4=--Xtab-width
    wrapper.app.parameter.5=4
    
    1. Hi there Bryce,

      I have it on good authority that this has not changed between versions, so it should work as intended.

      Please raise a JIRA issue, and attach a screenshot of the page where you were expecting the tab to be the desired size but you are seeing a different result.

      The FishEye team will then investigate.

      Cheers,


      Edwin Dawson
      Technical Writer
      edawson@atlassian.com
      ATLASSIAN - http://www.atlassian.com

  2. Jonas Andersson

    How do i backup and restore the HSQLDB-databases containing the crucible-users and comments?

    1. Erik van Zijst

      Hi Jonas,

      When you make a backup using the fisheyectl.sh backup command (or the "Backup" section in the admin UI), it will automatically include the entire hsqldb database, as well as the rest of your instance's data (uploaded files, config.xml, licenses, etc).

      To restore this archive in a new instance, simply unzip it in the $FISHEYE_INST/ directory.

      For more info, see Backing up and restoring Fisheye data.

      N.B.
      If you really want to extract just the HSQLDB database, you will find it in $FISHEYE_INST/var/data/crudb/ (do not touch this file while Crucible is running).

  3. Cameron R

    Wish for better wrapper documentation.  Took me awhile but for any else that needs to set the debug flag for Fisheye.  Edit the wrapper.conf file section like this

     Alse the line in the log Debug Enabled   : false never changes to true.

    # Application parameters.  Add parameters as needed starting from 1
    # The first application parameter is the name of the class whose main
    # method is to be called when the application is launched.  The class
    # name is followed by the number of parameters to be passed to its main
    # method.  Then comes the actual parameters.

    wrapper.app.parameter.1=com.cenqua.fisheye.FishEyeCtl
    wrapper.app.parameter.2=3
    wrapper.app.parameter.3=start
    wrapper.app.parameter.4=--debug
    wrapper.app.parameter.5=--debug-perf

    # The start parameters are followed by the name of the class whose main
    # method is to be called to stop the application.  The stop class name
    # is followed by a flag which controls whether or not the Wrapper should
    # wait for all non daemon threads to complete before exiting the JVM.
    # The flag is followed by the number of parameters to be passed to the
    # stop class's main method.  Finally comes the actual parameters.
    wrapper.app.parameter.6=com.cenqua.fisheye.FishEyeCtl
    wrapper.app.parameter.7=true
    wrapper.app.parameter.8=1
    wrapper.app.parameter.9=stop

  4. Anonymous

    --Xdisable-dirtree-empty-checks

    Have I got this right? This option will only disable the checks, that is, empty directories will be displayed like any other directory? Does this also include deleted directories?

    What I want to do is: disable checks for empty directories and DON'T display deleted directories. Is this possible?

    1. Anonymous

      Anyone?

    2. Daniel R

      You are correct – the empty directories will display like any other directory.  This doesn't apply to deleted directories.  Would you like me to file an enhancement on your behalf?

  5. Jason Brison

    Is there a command line for force stopping a repository? We have a GIT (remote) repository added to FishEye, it seemed to be stuck so I choose to restart the repository in FishEye which gave an error saying it timed out. Now the repository is just sitting in a 'stopping' state. I'd like to force stop the repository.

  6. Daniel R

    You can shutdown FishEye in its entirety from the command line but unfortunately, not just a specific repository. If you'd like to open a ticket on support.atlassian.com I'll be happy to investigate your issue further.

    1. Jason Brison

      Thank you for the prompt reply Daniel. I think a good FE would be the ability to kill a repository from the command line. For now I will not be opening a ticket though. I will see if it comes around to a full stop, if not I will upgrade FishEye from 2.7.9 > 2.7.11 (I'll probably do that anyway).