Windows Installation

Corus is preferrably installed using the Chef cookbook (there is exhaustive documentation for the cookbook). We're still providing instructions for manual installation below.

Preparing the Environment

There is a bit of preparation to do before actually extracting the Corus package.

Java

Before installing Corus you need to have Java installed on your machine. Corus requires at least Java 7. Also, Corus requires the presence of the $JAVA_HOME environment variable that points to the Java runtime you want to use (JRE or JDK).

Installation Directory

You need to create a directory on your system in which you will install Corus (that directory must contain NO SPACE in its path). For the purpose of this demonstration, we create the C:\opt\corus directory.

Extract the Corus Package

Extract the Corus package .zip file into the Corus installation directory created above (adjust the Corus version number to match yours). Rename the created root directory of the archive if you need. For example, with the 5.0 package, the root of Corus' installation would correspond to the following path: C:\opt\corus\sapia_corus_server_package-5.0 .

Configure the Environment

Corus requires a CORUS_HOME environment variable, which should point to the installation directory - that is: given version 5.0 and our deployment steps thus far, the following directory: C:\opt\corus\sapia_corus_server_package-5.0 . Also add the following to your PATH variable:

%CORUS_HOME%/bin

Once that is done, you should be able to run Corus manually, by simply typing corus in a DOS window.

Configure Discovery

Corus uses IP multicast for cluster discovery by default. But that method can be faulty (multicast might not be allowed in your network, or configured to go through routers), and it is typically not available in the cloud.

Corus supports TCP-based discovery: the different supported mechanisms (and their respective configuration) is explained in the Discovery section. Please consult that section for the details.

Windows Service Integration

With the installation of Corus as a Windows service, you will be able to automatically start Corus at the startup of your machine. Windows provides a simple service management user interface to stop, start and restart services. The Java Service Wrapper is used to run Corus as a service under Windows. The steps below indicate how to proceed.

Define a Corus Configuration File

First, define a Corus configuration file that will be used when the service starts. We provide a default configuration file to help you: it is located under %CORUS_HOME%\config\corus_service_33000.wrapper.properties . You can have a look at the configuration

Execute the Installation Script

A script is available to register Corus as a Windows Service, found at the following location: %CORUS_HOME%\bin\win32\InstallCorusService.bat. By default, the InstallCorusService.bat script is configured to use the %CORUS_HOME%\config\corus_service_33000.wrapper.properties config file. We recommend you leave everything in the default state, unless you have specific needs.

To proceed to the installation, just double-click on the above-mentioned batch file. To validate the installation, look at the Services management window to see that a new service called "Corus" is installed.

Once you start the Corus service, you can validate its proper execution by looking at the Corus log files under the $CORUS_HOME/logs directory.

You can also start the Corus CLI (Command Line Interface) to connect to the server. Simply type coruscli in a terminal window: this will connect you to the Corus instance running locally.

Managing the Corus Service

From the service management window you can start, stop and restart the Corus service. If you ever need to remove the Corus service, there is another script provided in the %CORUS_HOME%\bin\win32 directory: it is called UninstallCorusService.bat. You can use this script the same way you previously installed the Corus service.