Installing Crucible on Windows
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.
For OpenJDK, you'll need the DejaVu font package installed. The 'Microsoft Visual C++ Redistributable 2013' package may be necessary too (details).
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 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. Install Java
As of Crucible 4.8, JRE is no longer bundled with the installer.
Before you install Java, make sure you do not have a pre-existing installation already in place. In a command prompt, run this:
java -version
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.
5. Now it's time to get Crucible
The recommended way to install Fisheye is to use the installer, which installs Fisheye as a Windows service. Download the Crucible installer from the Atlassian download site.
The 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. This points to the location of the instance (data) directory. - The path to the installation location is referred to as the
<Crucible install directory>
- You need separate Crucible instance (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.
- You can edit JVM parameters for the Windows service by going to Start > All Programs > Crucible > Configure 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.
- In a web browser on the same machine, go to
http://localhost:8060/
(or, from another machine, typehttp://hostname:8060/
, wherehostname
is the name of the machine where you installed Crucible). - Enter your license and administration password. Note that this is a 'root password', not assigned to any user account. You can later designate users to be administrators as well. You can log in using this root password, 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