Installation

Install and run a Synnax Core on Linux, Windows, macOS, or Docker, and connect a Console to it.

This page will walk you through installing and running Synnax locally. By the end, you’ll have a running Core and a Console connected to it. Select your operating system to get started.

Step 1 Install the Core

The Core is the heart of every Synnax deployment. It stores all sensor and actuator data and serves as a central hub where devices, Consoles, and control sequences communicate.

Linux

Windows

macOS

Docker

Linux

Download the latest binary:

curl -LO https://github.com/synnaxlabs/synnax/releases/download/core/v0.58.2/synnax-v0.58.2-linux

Move the binary to /usr/local/bin and make it executable:

sudo mv synnax-v0.58.2-linux /usr/local/bin/synnax

chmod +x /usr/local/bin/synnax

If /usr/local/bin is not in your PATH, add it permanently:

echo 'export PATH=$PATH:/usr/local/bin' >> ~/.bashrc

For zsh, replace ~/.bashrc with ~/.zshrc.

Verify the installation:

synnax --version

You should see:

Synnax v0.58.2

Windows

Download and run the latest installer:

Download Synnax v0.58.2 for Windows

Releases for other operating systems and older versions can be found on the releases page.

Verify the installation by running the following in a PowerShell terminal:

synnax --version

You should see:

Synnax v0.58.2

macOS

Download the latest binary:

curl -LO https://github.com/synnaxlabs/synnax/releases/download/core/v0.58.2/synnax-v0.58.2-macos

Move the binary to /usr/local/bin and make it executable:

sudo mv synnax-v0.58.2-macos /usr/local/bin/synnax

chmod +x /usr/local/bin/synnax

If /usr/local/bin is not in your PATH, add it permanently:

echo 'export PATH=$PATH:/usr/local/bin' >> ~/.zshrc

Verify the installation:

synnax --version

You should see:

Synnax v0.58.2

Docker

A Synnax Core within a container has an isolated runtime, which means that it can’t access devices attached to the host machine. If you plan to connect data acquisition devices using the Synnax Driver, install Synnax directly on the host OS using one of the other methods.

Pull the latest image from Docker Hub:

docker pull synnaxlabs/synnax:latest

Step 2 Start the Core

Linux

Windows

macOS

Docker

synnax start --listen=localhost:9090 --mem --insecure

synnax start --listen=localhost:9090 --mem --insecure

synnax start --listen=localhost:9090 --mem --insecure

docker run -p 9090:9090 synnaxlabs/synnax --listen=localhost:9090 --mem --insecure

This starts a Core with the following configuration:

Table

Flag	Description
`--listen=localhost:9090`	Sets the address the Core will listen on
`--mem`	Store all data in memory (useful for learning and development)
`--insecure`	Run without TLS

The --mem flag is great for getting started, but data will be lost when the Core stops. See the CLI Reference for persistent storage options and other configuration flags. For production deployments, see Production.

To stop the Core, press Ctrl+C in the terminal.

Step 3 Install the Console

The Console is a desktop application for visualizing data, configuring devices, and controlling hardware. Download the latest release for your operating system:

Download v0.58.2 for macOS Download v0.58.2 for Windows

Releases for other operating systems and older versions can be found on the releases page.

After installing, you’ll see the login page:

Step 4 Connect the Console to the Core

The Console ships with a pre-configured connection to a local Core. It should appear in the list of available cors on the login page as ‘Local’. If the Core you started in the previous step is reachable, the status badge will turn blue and say ‘Connected’.

To log in, simply enter the root username and password:

Table

Username	synnax
Password	seldon

Next steps

Now that you have a running Core and Console, here are some places to go next:

Connect a data acquisition device using the Synnax Driver
Learn about channels and other key concepts
Write and read data using the Python or TypeScript client