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:latest
Installing 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.41.2/synnax-v0.41.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.41.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/bin
Or, you can add it permanently using the following one-liner for your shell:
echo 'export PATH=$PATH:/usr/local/bin' >> ~/.zshrc
If any previous versions of Synnax are installed and available on your PATH,
you may need to remove them to avoid conflicts.
If you’ve also installed the Synnax Python Client,
its synnax command may take precedence over the one you just installed. To
avoid conflicts, rename the binary you’ve just installed to something else, like
synnax-server by running:
mv /usr/local/bin/synnax /usr/local/bin/synnax-server
Then, you can run the binary using synnax-server instead of synnax.
Next, give execution permissions to the binary:
chmod +x /usr/local/bin/synnax
You 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 --version
You should see the following output:
Synnax version 0.41.2
Installing 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.41.2/synnax-v0.41.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.41.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/bin
Or, you can add it permanently using the following one-liner for your shell:
echo 'export PATH=$PATH:/usr/local/bin' >> ~/.bashrc
Or, for zsh:
echo 'export PATH=$PATH:/usr/local/bin' >> ~/.zshrc
If any previous versions of Synnax are installed and available on your PATH, you
may need to remove them to avoid conflicts.
If you’ve also installed the Synnax Python Client,
its synnax command may take precedence over the one you just installed. To
avoid conflicts, rename the binary you’ve just installed to something else, like
synnax-server by running (you may need to use sudo):
mv /usr/local/bin/synnax /usr/local/bin/synnax-server
Then, you can run the binary using synnax-server instead of synnax.
Next, give execution permissions to the binary:
chmod +x /usr/local/bin/synnax
You 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 --version
You should see the following output:
Synnax version 0.41.2
Installing on Windows
To install Synnax on Windows, download the latest binary from the following link:
$ErrorActionPreference = "Stop"; [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12;$ProgressPreference = 'SilentlyContinue'; $null = New-Item -Type Directory -Force $env:appdata/synnax; Invoke-WebRequest -Uri github.com/synnaxlabs/synnax/releases/download/synnax-v0.41.2/synnax-v0.41.2-windows -OutFile synnax.exe; Copy-Item -Force "synnax.exe" -Destination $env:appdata/synnax; $Env:PATH += ";$env:appdata/synnax"We recommend adding ;$env:appdata/synnax to your PATH environment variable,
which will allow you to execute synnax commands from any shell. See Microsoft’s Environment Variable
documentation for more.
If any previous versions of Synnax are installed and available on your PATH,
you may need to remove them to avoid conflicts.
If you’ve also installed the Synnax Python Client,
its synnax command may take precedence over the one you just installed. To
avoid conflicts, rename the binary you’ve just installed to something else, like
synnax-server by running:
Move-Item $env:appdata/synnax/synnax.exe $env:appdata/synnax/synnax-server.exe
Then, you can run the binary using synnax-server instead of synnax.
To verify that the installation was successful, run:
synnax --version
You should see the following output:
Synnax version 0.41.2