This is the documentation for FishEye 3.2. View the latest version of

Unknown macro: {spacejump}

or visit the latest FishEye documentation home page.

Getting FishEye up and running

Want to get up and running quickly? Follow these simple steps and you should have FishEye ready to go in no time. Setting up FishEye can take less than half an hour.

Install

First things first, if you haven't already got FishEye up and running carry out the relevant steps below:

Check Supported platforms before you begin.

  1. Download FishEye from the Atlassian Download Center
  2. Unzip the downloaded package to the desired installation directory: c:\fisheye (see the documentation if you need help with this).
  3. Launch FishEye from the command line, typing bin\start.bat. A FishEye console window will appear, listing the startup progress. Give it a few minutes to complete its process. When the message "server started" is displayed, you can continue.
    (info) You will also receive a warning in the console output about a 'missing license'. This is normal.
  4. On the same machine go to http://localhost:8060/ (or type the hostname or IP address in place of localhost from another machine) in your web browser. You will be prompted to enter a license key (obtained at http://my.atlassian.com) and set the admin password. (Tip: you can just use one Crucible evaluation license key to try both FishEye & Crucible.)

It should only take you a few minutes to have a running instance of FishEye. If you have any difficulty during the installation process (i.e. it takes longer than twenty minutes) please contact our support team for assistance. They're ready to help at any time.

Check Supported platforms before you begin.

  1. Download FishEye from the Atlassian Download Center
  2. Unzip the downloaded package to the desired installation directory: /opt/fecru-x.x.x (see the documentation if you need help with this).
  3. Launch FishEye from the command line, typing ./bin/run.sh . Console output will appear, listing the startup progress. Give it a few moments to complete its process. When the message "server started" is displayed, you can continue.
    (info) You will also receive a warning in the console output about a 'missing license'. This is normal.
  4. On the same machine go to http://localhost:8060/ (or type the hostname or IP address in place of localhost from another machine) in your web browser. You will be prompted to enter a license key (obtained at http://my.atlassian.com) and set the admin password. (Tip: you can just use one Crucible evaluation license key to try both FishEye & Crucible.)

It should only take you a few minutes to have a running instance of FishEye. If you have any difficulty during the installation process (i.e. it takes longer than twenty minutes) please contact our support team for assistance. They're ready to help at any time.

Scan

Once installed, FishEye needs to do an initial index, where it accesses, indexes and organizes a view of your repository (including all historical items) back to the earliest commit.

(info) FishEye operates in a completely read-only mode, so your repository data is safe. Also, always run FishEye on an SCM account that is limited to read-only access.

Click on the 'Administration' link in the footer bar to access the administration interface, then click 'Add Repository'.

There are lots of options when adding a repository, but in most situations you should be able to run with the defaults. For evaluation purposes, we recommend that you just index one project, which is usually a subset of your whole repository (rather than everything). If you choose to index your entire repository, just be aware that this can take a long time (possibly days) for massive or complex repositories and can be more complex to set up (especially for Subversion). Indexing just one project, you can have FishEye up and running quickly for evaluation. The basic process is slightly different for each SCM type. Carry out the respective process for your SCM below:

  • Subversion set the Path field to a subdirectory that includes the directories trunk, branches, tags for your project
  • Perforce & Git set the Path to a subdirectory that contains your project's source.
  • CVS set the CVS dir to point to your project.

The default indexing settings can have challenges digesting non-standard SCM configurations. If the initial index appears to hang, please call support as this usually indicates you have a configuration problem, that can be quickly resolved by our friendly support engineers.

Check out the best practices guide for your FishEye configuration if you have a large repository or are having difficulty with setup.

Add Users

FishEye was designed to improve team communication through sharing SCM artifacts, so you will probably want to add accounts for all your team members.  There are a few approaches that you can take to adding users:

  1. Leave FishEye in anonymous mode. There are two downsides here, anyone who can see FishEye, can see all the source and you won't be able to use email watches or save preferences.
  2. Built-in users with "public sign up". Anyone can create an account, but not especially secure.
  3. Built-in users. This is simple to set up for a small user base, however adding each user manually is not recommended for large-scale systems with many users.
  4. External authentication. This includes sources such as LDAP, Active Directory or similar.
    1. Atlassian Crowd. If you already have a Crowd server, this is a snap to set up.
    2. LDAP/Active Directory. You can point FishEye at your existing corporate directory. If you are familiar with LDAP, this should be easy.
    3. Host/PAM Authentication. You can use the local accounts from the physical machine FishEye is running on.

If you opt for accounts, be sure to make yourself and other relevant users FishEye administrators. You may also be interested in pre-loading users from LDAP/Crowd and setting repository level access control based on groups.

Configure Mail (optional)

FishEye can deliver email feeds based on user configured parameters. For example, you can watch the contributions of a specific colleague or changes to a branch of code you're working on. To take advantage of this feature, you will need to tell FishEye about your SMTP server.

Configure JIRA (optional)

  1. If you already have a JIRA server set up, you can go ahead and set up integration between the two. Once established, activity on relevant JIRA issues will appear in the FishEye activity stream. JIRA issue keys will also be hyperlinked, also a small information window will load when you mouse-over JIRA issue keys.
  2. Visit the FishEye documentation for instructions on how to set up JIRA integration in FishEye.

Setup Complete!

Congratulations! Our support records indicate that over 80% of support calls happen during this installation phase. Once you have made it this far, the rest of the evaluation ought to flow smoothly.

If you do need assistance, our support team is ready to help. Create an issue at our support system under the FishEye project.

There are heaps of tweaks and configuration options that you can experiment with. Check out the FishEye Administrator's Guide for more information.

  • No labels