Installing Synnax
Install the Synnax core components.
The first step to getting started with Synnax is to install two key components: the Console and Core.
Install the Synnax Console
The Synnax Console is our primary user interface for interacting with a Synnax deployment. We can set up visualizations to observe data, integrate and configure data acquisition devices, and manually control actuators on our system. Here’s the link to download the latest version of the Console for your OS:
After downloading and running the installer, you’ll see a splash screen that looks like this:
Plotting Demo Data
To make sure everything is working correctly, we’ll plot some live data. Our team has a
demo Core running in the cloud that we can connect to. Head to the Core Selector in the
top-right corner, and select the Core named Demo.
You’ll see the connection status badge on the right turn blue, indicating that the connection is healthy.
Next, click on the Workspace Selector in the top-left corner of the screen. This will open a dropdown menu where we can select the workspace we want to use. Choose the “Demo” workspace. You’ll see the Console automatically re-configure its layout to match the workspace, and a new plot will appear with a live stream of data.
Installing the Core
Now that the Console is up and running, we’ll install our own Synnax Core locally. The Core is the heart of every Synnax deployment. It’s where all sensor and actuator data is stored, and it serves as a central hub where all of our devices, Consoles, and control sequences will communicate.
Using Docker
A Synnax Core within a container has an isolated runtime, which means that it’s not currently able to access devices attached to the host machine. If you’re interested in connecting data acquisition devices using the embedded Synnax Driver, we recommend installing Synnax directly on the host OS using one of the other installation methods.
The simplest way to start a Core is by using the synnaxlabs/synnax Docker image:
docker run -p 9090:9090 synnaxlabs/synnax --listen=localhost:9090 --mem --insecureThis will pull the latest version of Synnax from Docker Hub and start a Core with the following parameters:
-p 9090:9090 - This maps port 9090 on the host to port 9090 in the container. This
allows access to the Synnax Core from the host machine.
--listen=localhost:9090 - This sets the address that the Core will listen on. This is
the reachable address of the Core.
--mem - Tells the Core to store all data in memory, which is useful for learning and
development.
--insecure - Tells the Core to run without TLS.
If you’re interested in more details on these flags, see the CLI Reference.
To stop the Core, simply press Ctrl+C in the terminal.
Using macOS
To start a Core on macOS, first download the latest Synnax binary by running:
curl -LO github.com/synnaxlabs/synnax/releases/download/synnax-v0.48.0/synnax-v0.48.0-macosNext, move the binary to usr/local/bin:
sudo mv synnax-v0.48.0-macos /usr/local/bin/synnaxThen, give execution permissions to the binary:
chmod +x /usr/local/bin/synnaxYou’ll need to make sure that /usr/local/bin is in your PATH environment variable.
You can do this temporarily by running export PATH=$PATH:/usr/local/bin.
Finally, start the Core:
synnax start --listen=localhost:9090 --mem --insecureThis will start a Core with the following parameters:
--listen=localhost:9090 - This sets the address that the Core will listen on. This is
the reachable address of the Core.
--mem - Tells the Core to store all data in memory, which is useful for learning and
development.
--insecure - Tells the Core to run without TLS.
If you’re interested in more details on these flags, see the CLI Reference.
To stop the Core, simply press Ctrl+C in the terminal.
Using Linux
To start a Core on Linux, first download the latest Synnax binary by running:
curl -LO github.com/synnaxlabs/synnax/releases/download/synnax-v0.48.0/synnax-v0.48.0-linuxThen, move the binary to /usr/local/bin:
sudo mv synnax-v0.48.0-linux /usr/local/bin/synnaxNext, give execution permissions to the binary:
chmod +x /usr/local/bin/synnaxYou’ll need to make sure that /usr/local/bin is in your PATH environment variable.
You can do this temporarily by running export PATH=$PATH:/usr/local/bin.
Finally, start the Core:
synnax start --listen=localhost:9090 --mem --insecureThis will start a Core with the following parameters:
--listen=localhost:9090 - This sets the address that the Core will listen on. This is
the reachable address of the Core.
--mem - Tells the Core to store all data in memory, which is useful for learning and
development.
--insecure - Tells the Core to run without TLS.
If you’re interested in more details on these flags, see the CLI Reference.
To stop the Core, simply press Ctrl+C in the terminal.
Using Windows
To install the Synnax Core on Windows, download and run the latest Synnax installer.
Releases for other operating systems and older versions can be found on the releases page.
To start the Core, run this:
synnax start --listen=localhost:9090 --mem --insecureThis will start a Core with the following parameters:
--listen=localhost:9090 - This sets the address that the Core will listen on. This is
the reachable address of the Core.
--mem - Tells the Core to store all data in memory, which is useful for learning and
development.
--insecure - Tells the Core to run without TLS.
If you’re interested in more details on these flags, see the CLI Reference.
To stop the Core, simply press Ctrl+C in the terminal.
Connecting the Console to the Core
Now that we have a Core running, we’ll disconnect the Console from the demo Core and
connect it to our own. We’ve pre-populated the Console with a connection for the default
admin user on a local Core. To connect, head to the Core Selector in the top-right
corner of the Console and select the Core named Local.
Again, you’ll see the connection status badge on the right turn blue, indicating that the connection is healthy. If you’ve changed the username or password, or removed the connection, you’ll need to re-add it. Here are the connection details:
| Host | localhost |
|---|---|
| Port | 9090 |
| Username | synnax |
| Password | seldon |
| Secure | false |
Next Steps
Now that we have a local Core running, it’s time to start acquiring data from a device. Check out the Synnax Driver to start integrating your own hardware.