Installing Squore Server for NFS-Mounting

Squore Server can be installed on a NFS share so that other clients can mount this share and run their own instance of the installation, working locally with their own data. This installation mode is only available on Linux and differs slightly from a conventional installation, as described in the section called “Advanced Server Installation using an NFS Mount”.

In this section, we wil refer to the machine that shares the Squore Server binaries as the Master Squore Server and to each machine that instanciates the remote installation as a Squore Server Instance.

Contept and Prerequisites

The Master Squore Server is installed once on the NFS Server, defining the default locations of the data files and the port numbers to use on each Squore Server Instance. In order to instantiate the Squore Server Instance, the install script is run again to create the local data and override the default configuration if needed.

Before you start:

  • Configure the NFS Server to share /opt/squore/squore-server (where the Master Squore Server will be installed)

  • Mount the Master Squore Server installation folder on each machine that will run a Squore Server Instance

  • Ensure that the web and database ports you plan to use are available on the Master Squore Server and each Squore Server Instance

Note

Some installation parameters are shared between the Master Squore Server and all Squore Server Instances (web and DB ports, LDAP and SSL configuration and other parameters from <SQUORE_HOME>/server/standalone/configuration/standalone.xml and <SQUORE_HOME>/server/bin/standalone.conf), others can be overridden with command line parameters on each Squore Server Instance (postgresql settings and other parameters from postgresql.conf, and <SQUORE_HOME>/config.xml).

The full list of options accepted by the install script can be found in install(1).

If you plan on overriding parameters defined in the Master Squore Server installation, create an environment variable called SQUORE_CONFIG on the machine before installing the Squore Server Instance. When initialising the instance, a config.xml file with the parameters specific to the instance will be created in the location defined by the SQUORE_CONFIG environment variable.

Installing the Master Squore Server

You can perform the installation using these commands:

# cd /opt
# tar xf <path>squore-server-linux-16.3.4.<buildNumber>.tar.bz2
# cd squore-server
# ./bin/install -w [options] /datadir

With the command line above, data will be available in:

  • Squore projects: $datadir/projects

  • Squore cluster: $datadir/cluster

  • JBoss AS data directory: $datadir/jboss/data (*)

  • JBoss AS log directory: $datadir/jboss/log (*)

  • JBoss AS temporary directory: $tmpdir/jboss (*)

(*) different from a standard installation

These data folders are the ones that will also be created and used by default on each Squore Server Instance later.

Note

In order to ensure correct installation of Squore Server Instances, ensure that you apply the following permissions in the Master Squore Server installation folder:

  • chmod 644 server/standalone/configuration/*.properties (contains internal Squore passwords)

  • chmod 644 server/standalone/configuration/*.xml (contains LDAP, SSL and database passwords)

  • find server/standalone/data -type f | xargs chmod 644

  • find server/standalone/data -type d | xargs chmod 755

Installing a Squore Server Instance

On each machine where a Squore Server Instance will be installed, mount the folder containing the Master Squore Server installation.

To initialise each Squore Server Instance, the installation script needs to be run with the -X flag to create the local data folders:

# cd /opt/squore-server
# ./bin/install -X [options] [data_dir]

When the installation completes, you can start Squore Server with:

# ./bin/sqctl start

Patching Squore Server in a NFS Context

You can follow the procedure below if you need to deploy a patch on the Master Squore Server:

  1. Shutdown all Squore Server Instances

  2. Shutdown the Master Squore Server

  3. Patch the Master Squore Server installation on the NFS Server following the instructions from https://openwiki.squoring.com/index.php/Deploying_A_Patch#Since_Squore_16.1.2.

  4. Run the upgrade script on each Squore Server Instance as described in the section called “Upgrading NFS-Mounted Installations”.

  5. Start all Squore Server Instances