Installing the Server software
Installation must be performed by a user with administrative privileges. On some operating systems, you can double click on the installer file icon to begin installation. Depending on your operating system you may be prompted for your password or asked to allow the installation to be performed.
- On Linux, installing to a central location will normally involve running the installation script as an administrative user - either by logging in as one, or by prefacing the command with sudo. Please check that the installation script has executable permissions before executing it.
- On Windows systems, you may need to right click on the installer file icon, and choose to Run as administrator.
You will be prompted for the location to install the software (figure 2.1). If the installer detects that a version of the software is already installed, you will have the option to update the existing installation or to install the CLC Server to a different directory (figure 2.2). For standard upgrades, choose to update the existing installation.
The directory the software is installed into will be referred to as the server installation directory throughout the rest of this manual.
Figure 2.1: If installing for the first time, the location to install to is specified.
Figure 2.2: For standard upgrades, choose to update the existing installation.
The installer allows you to specify the maximum amount of memory the CLC Server Java Virtual Machine (JVM) can make use of (figure 2.3). By default, the value is set to 50% of the available RAM on the system you have installed the software on, or 50 Gb, whichever is smallest. If you do not have a specific reason to change this value, leave it at the default setting. Further details about this setting are provided in Setting the amount of memory available for the JVM.
Figure 2.3: Choose the maximum amount of memory used by the server.
System-specific notes
- Linux You will be offered the option to specify a user account that will be used to run the CLC Server process. Having a specific, non-root user for this purpose is generally recommended. On a standard setup, this would have the effect of adding this username to the
systemdservice unit file describing the CLC Server service, and setting the ownership of the files in the installation area to this user. Downstream, the user running the CLC Server process will own files created in File Locations, for example, after data import or data analyses. - Windows You will be offered the choice of starting the service manually or automatically.
After installation is complete
After the installation is complete, the service will start up if you selected the option to start up the service at the end of the installation process (Linux, Mac), or if you chose to start the service automatically (Windows). If this is the first installation into the location chosen, then there will not be a license file in place. In this case, the CLC Server process will be running in a limited capacity (aka "job node mode").
On a single server, or master server, a license needs to be installed. This is described in section Downloading a license.
Information on stopping and starting the CLC Server service is provided in section Starting and stopping the server.