Install Fusion on a Single Node

Note
These instructions are for an initial installation of Fusion on a single node (computer). To install Fusion on multiple nodes (a Fusion cluster), see Install a Fusion Cluster. If you already have a version of Fusion installed and want to upgrade it, see the Fusion upgrade instructions.

Out of the box, Fusion uses the instances of Solr, ZooKeeper, and Spark that are included in the Fusion distribution. See the release history to find out which versions of Solr, Spark, and ZooKeeper are included in each Fusion release.

To use Fusion with your existing Solr installations, see Integrating with existing Solr instances.

Ports

To run Fusion as a single-server installation, the following ports should be available and not used by other applications or services:

  • 8764

  • 8765

  • 8983

  • 8984

See Default Ports if you need to modify the default Fusion ports before starting the application.

Unix installation

Fusion for Unix is distributed as a gzipped tar file.

To install Fusion on Linux or Mac
  1. Download the Fusion tar/zip file for the latest version of Fusion and move it to where you would like it to reside in your filesystem (if you would like to use Upstart for process management, you must install Fusion in /opt/lucidworks).

  2. Become the user that will run Fusion.

    Important
    Do not run Fusion as the root user.
  3. Change your working directory to the directory in which you placed the fusion-version.x.tar.gz file, for example:

    $ cd /opt/lucidworks

  4. Unpack the archive with tar -xf (or tar -xvf), for example:

    $ tar -xf fusion-version.x.tar.gz

    The resulting directory is named fusion/3.0.x. You can rename this if you wish. This directory is considered your Fusion home directory. See Directories and Logs for the contents of the fusion/3.0.x directory.

Starting Fusion

All Fusion start scripts must be executed by a user who has permissions to read and write to the directories where Fusion is installed. These scripts don’t need to be run as root (or sudo), nor should they be. Use a suitable ID, or create a new one, and then ensure that it owns the directory where Fusion resides, (e.g. /opt/lucidworks).

To start all required services

./bin/fusion start

For information about starting individual services, see Start and Stop Fusion.

Running Fusion In The Foreground

To run Fusion or any of its services in the foreground, use the run command-line argument in place of start.

Stopping Fusion

To stop Fusion or any of its services, use the stop command-line argument in place of start.

Ubuntu Upstart Scripts

Under Ubuntu 12.04 LTS or newer we support Upstart for process management. This requires Fusion to be installed in the /opt/lucidworks/ directory.

To configure upstart, run the following commands:

$ cd init/upstart
$ sudo bash install.sh

If this complains with no JAVA_HOME set, replace sudo with sudo -E. Then you can use the service command to control the server:

$ sudo service fusion-solr start
$ sudo service fusion-api start
$ sudo service fusion-connectors start
$ sudo service fusion-ui start

and similarly use stop and status.

Logfiles for Fusion services are found in directories under fusion/3.0.x/var/log.

Upstart log files for each service are in the /var/log/upstart directory.

For convenience, you can start/stop all services with Upstart using:

$ sudo bash start.sh
$ sudo bash stop.sh

Windows installation

Fusion for Windows is distributed as a compressed zip file. To unpack the Fusion zip file on Windows, you can use a native compression utility or the freely available 7zip file archiver. Visit the 7zip download page for the latest version.

To install Fusion on Windows
  1. Download the zip file for the latest version of Fusion and move it to where you would like Fusion to reside in your filesystem. It will appear as a compressed folder.

  2. Unpack the archive. In most cases, you need only right-click and choose "Extract all…​". If you don’t see this option, check that you have permissions to extract folders on your system.

    The resulting directory is named fusion\3.0.x. This directory is considered your Fusion home directory. See Directories and Logs for the contents of the Fusion home directory.

To install Fusion as a set of Windows services
  1. Run bin/install-services.cmd.

  2. Enter the name of the windows user that is used to launch this service.

    Remember the username is COMPUTERNAME\username or DOMAIN\username (if your computer is part of a Windows domain).

  3. Enter the user’s password.

  4. Enter the path to the directory containing the JDK to use for running the services.

Starting Fusion

All Fusion start scripts must be executed by a user who has permissions to read and write to the directories where Fusion is installed. Ensure that such a user owns the directory where Fusion resides.

To start all required services
  • bin\fusion.cmd start

  • bin\start-services.cmd (Start all Fusion services as Windows services)

For information about starting individual services, see Start and Stop Fusion.

Stopping Fusion

To stop Fusion or any of its services, use the stop command-line argument in place of start.

Installation with an existing Solr instance or cluster

Fusion supports Solr versions 4.4 and higher. Solr 4.6.0 or 4.7.0 are not supported, as they contain severe bugs that will impact the ability of Fusion to work with your Solr system.

If installing Fusion to work with an existing Solr instance, either in SolrCloud mode or standalone, you should install Fusion as described above. You should start each of the services as described above.

Once Fusion installation is complete, you can register your existing Solr installation with Fusion to be able to use the two systems together. For details on how to do that, see the section Search Clusters.

Troubleshooting

For information about problems you might encounter when installing Fusion, and solutions, see Troubleshoot When Installing Fusion.