Installing Crucible on Windows

Still need help?

The Atlassian Community is here for you.

Ask the community

This page...

... describes how to perform a clean install of Crucible on Windows.

Upgrading?

If you're upgrading your Crucible installation, read the Crucible upgrade guide first.

Upgrading from FishEye?

If you already have FishEye installed, you should read Upgrading from FishEye to Crucible instead.

1. Check supported platforms

Better check the Supported platforms page first; it lists the application servers, databases, operating systems, web browsers and JDKs that we have tested Crucible with, and that we recommend.

Atlassian only officially supports Crucible running on x86 hardware and 64-bit derivatives of x86 hardware.

2. Create a dedicated Crucible user (recommended)

For production installations, we recommend that you create a new dedicated Windows user that will run Crucible on your system. This user:

  • Should not have admin privileges.
  • Should be a non-privileged user with read, write and execute access on the Crucible home (install) directory and instance (data) directory. These directories are described below.
  • Should only have read access to your repositories. 

If you created a dedicated Crucible user, ensure you are logged in as this user to complete the remaining instructions.

3. Check your version of Java

In a command prompt, run this:

java -version

The version of Java should be 1.8.x.

The recommended way to install Crucible is to use the installer, which installs Crucible as a Windows service – see step 5 below. 

If you don't see a supported version of Java, then get Java...

Download and install the Java Platform JDK from Oracle's website.

(warning) We recommend that the Java install path should not contain spaces, so don't install into C:\Program Files\Java\. Instead, use a path like C:\Java.

Now try running 'java -version' again to check the installation. The version of Java should be 1.8.x.

4. Check that Windows can find Java

Windows uses the JAVA_HOME environment variable to find Java. To check that, in a new command prompt, run:

echo %JAVA_HOME%

You should see a path to the Java install location. We recommend that this path does not contain spaces, and that JAVA_HOME should point to the JDK home path.

If you don't see a path without spaces...
  • If you see a path with spaces, like  C:\Program Files\Java\, then sorry, but go back to 3. and reinstall Java to a location that doesn't have spaces.

  • If you don't see a path at all, or if you just see %JAVA_HOME%, then set JAVA_HOME as follows:

For Windows 7:

  1. Go to Start, search for "sys env" and choose Edit the system environment variables.
  2. Click Environment Variables, and then New under 'System variables'.
  3. Enter "JAVA_HOME" as the Variable name, and the absolute path to where you installed Java JDK as the Variable value, that is, something like C:\Java\jdk1.7.0_51. Don't use a trailing backslash. We recommend that JAVA_HOME should point to the JDK home path.
  4. Now, in a new command prompt,  try running 'java -version'. You should see the same version of Java as you saw above.

5. Now it's time to get Crucible

Download the Crucible installer from the Atlassian download site.

There are 32-bit and 64-bit installers for Crucible on Windows. Each installer adds Crucible as a Windows service, and starts the service, automatically. The express install creates, by default, a Data directory and a separate install directory  in C:\Atlassian. The custom install mode allows you to choose different locations for the install and Data directories, with the restriction that the Data directory must not be contained in the install directory.

  • The installer creates the FISHEYE_INST system environment variable.
  • The path to the installation directory is referred to as the <Crucible home directory> in these instructions.
  • You need separate Crucible data directories if you want to run multiple copies of Crucible.
  • If you expect to have a large number of users for this Crucible installation, and Crucible will be connected to an external database, consider installing Crucible on a different server from the one running the external database, for improved performance.
  • If you have a large number of repositories, we recommend you increase the default number of files that Crucible is allowed to open. See the following knowledge base article for more info: Subversion Indexer Paused with "Too many open files" Error.
  • For Crucible 3.4.4 and later, you can edit JVM parameters for the Windows service by going to Start > All Programs > CrucibleConfigure Crucible. Ensure that you restart the Crucible service when finished. Do not reference any environment variables in the settings (e.g. %FISHEYE_INST%). Instead, set the actual path.

6. Visit Crucible!

Give the Crucible service a minute to launch. Then, in a web browser on the same machine, go to http://localhost:8060/ (or, from another machine, type http://hostname:8060/, where hostname is the name of the machine where you installed Crucible).

Enter your license, then an admin password, to finish the setup. Note that this password is for the 'built-in' Crucible admin user. You can log in as this user, if necessary, by clicking the Administration link in the page footer. See also How to reset the Administration Page password in Fisheye or Crucible.

You can postpone setting up JIRA integration until later if you wish; see Configuring JIRA integration in the Setup Wizard.

7. Connect to an external database (recommended)

If you intend to use this Crucible installation in a production environment, it is highly recommended that you use one of the supported external databases. See Migrating to an external database.

If you are evaluating Crucible, or don't wish to do this now, Crucible will happily use its embedded database, and you can easily migrate later.  

8. Set up your mail server

Configure the Crucible email server so that users can get notifications from Crucible. See Configuring SMTP.

9. Add users and repositories

Now is the time to set up your users in Crucible, and to tell Crucible about any existing repositories you have. Please read Starting to use Crucible for the details.

Crucible will perform an initial index of your repositories, during which it accesses, indexes and organizes a view of your repositories (including all historical items) back to the earliest commits. If you are evaluating Crucible, we suggest that you index a single project, so you can use Crucible as soon as possible. If you choose to index your entire repository, 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). The basic process is slightly different for each SCM type.

10. Stop Crucible (optional)

Control the Crucible service from the Windows administration console. Alternatively, in a command prompt, change directory to <Crucible home directory> and run this:

bin\stop.bat
Last modified on Jan 19, 2017

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.