Linux setup

The short one liner

If you are not interested in a detailed overview, here is a one line shell command that:

1. downloads the current release of the installation archive into a temporary directory
2. extracts it and runs the CLI setup with sudo, which installs the software or updates it to the latest release if it is already installed

For the x86_64 (AMD64) architecture

If you prefer wget:

wget -nv -O setup.sh https://dl.syncplify.com/ss-setup-linux-x64w.sh && sudo sh setup.sh

If you prefer curl:

curl -fsS -o setup.sh https://dl.syncplify.com/ss-setup-linux-x64c.sh && sudo sh setup.sh

For the ARM architecture

If you prefer wget:

wget -nv -O setup.sh https://dl.syncplify.com/ss-setup-linux-armw.sh && sudo sh setup.sh

If you prefer curl:

curl -fsS -o setup.sh https://dl.syncplify.com/ss-setup-linux-armc.sh && sudo sh setup.sh

Any argument given to the script is forwarded to the installer, so an unattended installation is:

sudo sh setup.sh -S

Detailed overview

The following video shows how to install Syncplify Server! on a Linux operating system:

First, download the most recent version of the software for your architecture from syncplify.com/download. Then extract it and install it with these two commands.

To extract the downloaded archive:

tar -xvf name_of_downloaded_targz_archive.tar.gz

To begin installing (or updating) the software:

sudo ./ss-setup install

At the end of this phase a URL is shown. Open it in a browser to continue with the rest of the setup: the wizard asks whether this node is a standalone server or joins an existing cluster, gives the node an ID, creates the first SuperAdmin account (its username is always sa), offers two factor authentication for it, and ends with the address of the SuperAdmin UI.

INFO

The URL references localhost (127.0.0.1). If you use a browser on a different computer, replace 127.0.0.1 with the IP address of the machine where you just installed Syncplify Server!. The browser shows a certificate warning, because the web service starts with a self signed certificate; accept it for now, a certificate from a trusted authority can be installed later.

How to update or upgrade

The same install verb updates the software, without affecting your configuration, when Syncplify Server! is already installed: the installer detects the existing installation and performs an update or an upgrade instead of a new install. From version 8.4.0 the installer hands the update over to the product's own updater, so a backup of the configuration database is taken first, the previous version is kept in a rollback slot, and the node is health checked afterwards, exactly as when the server updates itself. In a cluster, update one node at a time.

The installer refuses to replace a newer version that the server installed on its own; add --allow-downgrade to install the older version deliberately.

How to uninstall

To make uninstallation easier, the installer copies the ss-setup executable to /usr/local/bin, which is in the PATH of most shells. To uninstall Syncplify Server!, open a terminal anywhere and type:

sudo ss-setup uninstall

After that, if you also want to remove the uninstaller itself:

sudo rm /usr/local/bin/ss-setup

And, just in case, you can also repair

Should anything happen, the same ss-setup you downloaded and extracted can repair your deployed executables and reset the database configuration, keeping your data intact:

sudo ./ss-setup install --repair

Command line flags

All of these go with the install verb, except --silent, which every verb accepts.

Flag	Purpose
-S, --silent	No user interaction: every prompt is answered yes, which includes accepting the license agreement in full. For unattended installations.
-R, --repair	Repair installation: replaces the executables and resets the database configuration while keeping the data intact.
-F, --force	Forces a new installation, even on a system that already has an old version installed. Used only in the fallback upgrade procedure.
--bakfile <file>	Initializes the new installation from an existing backup file.
--nodename <name>	The ID of this node (lowercase, no spaces, no special characters), for unattended installations.
--saname, --sapass, --saemail	Username, password and email of the first SuperAdmin account, for unattended installations that skip the web wizard.
--allow-downgrade	Allows installing this setup's version over a newer one that the server installed by updating itself.

INFO

The --update, --trace and --norollback flags of the v6 installer do not exist in the v8 installer. Remove them from any deployment script you carry over.