Doc downloads (PDF, HTML & XML)
[Crucible Knowledge Base]
Hey! We're going to install Crucible on a Linux box, or a Mac. There are a few steps involved, but we think you'll find it easy to follow along. If you already have FishEye installed, you should read Upgrading from FishEye to Crucible instead.
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.
In a terminal, run this:
java -version
The version of Java should be 1.6.0 – 1.7.x (or 1.7.x for OpenJDK).
In a terminal, run this:
echo $JAVA_HOME
You should see a path something like:
OSX | /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home/ |
Linux | /usr/lib/jvm/default-java |
For production installations, we recommend that you create a new user account on your operating system that is dedicated to running Crucible. This user:
If you created a dedicated Crucible user, ensure you are logged in as this user to complete the remaining instructions.
<Crucible home directory>
in these instructions. If you use FishEye and Crucible together, they run as one instance, and use the same home directory – see Crucible and FishEye. The Crucible instance directory is where your Crucible data is stored.
Tell Crucible where you created the instance directory by adding a FISHEYE_INST environment variable as follows:
Linux | Mac |
---|---|
Open the FISHEYE_INST="path/to/<Crucible instance directory>" | Open the FISHEYE_INST="path/to/<Crucible instance directory>" export FISHEYE_INST |
<Crucible home directory>
\
config.xml
file to the root of your new Crucible instance directory.
You should not locate your Crucible instance directory inside the
— they should be entirely separate locations. If you do put the instance directory in the <Crucible home directory>
it will be overwritten, and lost, when Crucible gets upgraded. And by the way, you'll need separate Crucible instance directories if you want to run multiple copies of Crucible.<Crucible home directory>
If you have a large number of repositories, we recommend you increase the default number of files that FishEye is allowed to open. See the following knowledge base article for more info: Subversion Indexer Paused with "Too many open files" Error.
In a terminal, change directory to <Crucible home directory>
and run this:
bin/start.sh
After a few moments, 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 extracted Crucible).
Enter your license, then an admin password, to finish the setup.
You can postpone setting up JIRA integration until later if you wish; see Configuring JIRA integration in the Setup Wizard.
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.
Configure the Crucible email server so that users can get notifications from Crucible. See Configuring SMTP.
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.
In a terminal, change directory to <Crucible home directory>
and run this:
bin/stop.sh