Cluster Installation
Install Synnax on a variety of operating systems.
This page will walk you through how to install the Synnax binary on Windows, macOS, and Linux. To get started, select your operating system below:
Installing on Docker
Installing Synnax via Docker is as easy as running docker pull with the latest tag:
docker pull synnaxlabs/synnax:latestInstalling on macOS
To install Synnax on macOS, run the following command to download the latest binary:
curl -LO github.com/synnaxlabs/synnax/releases/download/synnax-v0.45.2/synnax-v0.45.2-macosWe recommend you move the binary into a directory that is in your PATH. Most of our
users use /usr/local/bin:
sudo mv synnax-v0.45.2-macos /usr/local/bin/synnaxIf usr/local/bin is not in your PATH, you can temporarily add it by running the
following:
export PATH=$PATH:/usr/local/binOr, you can add it permanently using the following one-liner for your shell:
echo 'export PATH=$PATH:/usr/local/bin' >> ~/.zshrcIf any previous versions of Synnax are installed and available on your PATH, you may
need to remove them to avoid conflicts.
Next, give execution permissions to the binary:
chmod +x /usr/local/bin/synnaxYou may need to use sudo to run the above command if you do not have the necessary
permissions.
To verify that the installation was successful, run:
synnax --versionYou should see the following output:
Synnax version 0.45.2Installing on Windows
Install the Synnax cluster on Windows by downloading and running the latest installer:
Releases for other operating systems and older versions can be found on the releases page.
To verify that the installation was successful, run the following command in a PowerShell terminal:
synnax --versionYou should see the following output:
Synnax version 0.45.2Installing on Linux
To install Synnax on a Linux distribution, run the following command to download the latest binary:
curl -LO github.com/synnaxlabs/synnax/releases/download/synnax-v0.45.2/synnax-v0.45.2-linuxWe recommend you move the binary into a directory that is in your PATH. Most of our
users use /usr/local/bin:
sudo mv synnax-v0.45.2-linux /usr/local/bin/synnaxIf usr/local/bin is not in your PATH, you can temporarily add it by running the
following:
export PATH=$PATH:/usr/local/binOr, you can add it permanently using the following one-liner for your shell:
echo 'export PATH=$PATH:/usr/local/bin' >> ~/.bashrcOr, for zsh:
echo 'export PATH=$PATH:/usr/local/bin' >> ~/.zshrcIf any previous versions of Synnax are installed and available on your PATH, you may
need to remove them to avoid conflicts.
Next, give execution permissions to the binary:
chmod +x /usr/local/bin/synnaxYou may need to use sudo to run the above command if you do not have the necessary
permissions.
To verify that the installation was successful, run:
synnax --versionYou should see the following output:
Synnax version 0.45.2