Deployment quick start

Start a Core for testing, learning, or development.

This page will walk you through starting a Synnax Core. To get started, select your operating system below:

Linux

Windows

macOS

Docker

Using Linux

To start a Core on Linux, first download the latest Synnax binary by running:

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

Then, move the binary to /usr/local/bin:

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

Next, give execution permissions to the binary:

chmod +x /usr/local/bin/synnax

You’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 --insecure

This will start a Core with the following parameters:

Table

Flag	Description
`--listen=localhost:9090`	Sets the address that the Core will listen on
`--mem`	Store all data in memory (useful for learning and development)
`--insecure`	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

Download Synnax v0.58.2 for Windows

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

To start the Core, run this command in a PowerShell terminal:

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

This will start a Core with the following parameters:

Table

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

The Core CLI Reference contains more details about these flags.

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 https://github.com/synnaxlabs/synnax/releases/download/core/v0.58.2/synnax-v0.58.2-macos

Next, move the binary to usr/local/bin:

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

Then, give execution permissions to the binary:

chmod +x /usr/local/bin/synnax

You’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 --insecure

This will start a Core with the following parameters:

Table

Flag	Description
`--listen=localhost:9090`	Sets the address that the Core will listen on
`--mem`	Store all data in memory (useful for learning and development)
`--insecure`	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 Docker

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 --insecure

This will pull the latest version of Synnax from Docker Hub and start a Core with the following parameters:

Table

Flag	Description
`-p 9090:9090`	Maps port 9090 on the host to port 9090 in the container
`--listen=localhost:9090`	Sets the address that the Core will listen on
`--mem`	Store all data in memory (useful for learning and development)
`--insecure`	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.

Activating a license

A standalone Core needs a license from your organization. A Core without one starts and answers login and connectivity checks, but refuses everything else until a license key is activated. The Console shows an activation screen for it. The production guide covers the activation flow and the start flags that take a license key.

Installation