0.60

ReferenceEnterpriseEnterprise

Set up Synnax Enterprise

Install and start a Synnax Core, log in from the Console, and activate a license.

Synnax Enterprise is a Synnax Core that your team runs on its own computers. People connect to it with the Synnax Console, the client libraries, and standalone Synnax Drivers, and each person logs in as a user. To compare Enterprise with Synnax Desktop, see Synnax editions.

Do the steps below to install a Core, start it, log in, and activate its license. You need:

Step 1Install the Core

Select your operating system.

Download the latest binary:

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

Move the binary to /usr/local/bin:

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

Make the binary executable. If you do not have the necessary permissions, use sudo:

chmod +x /usr/local/bin/synnax

If /usr/local/bin is not in your PATH, add it. This command is for bash. For zsh, change ~/.bashrc to ~/.zshrc:

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

Verify the installation:

synnax --version

You should see:

Synnax v0.60.0

Step 2Start the Core

synnax start --listen=localhost:9090 --insecure
Flag Description
--listen=localhost:9090 The address of the Core.
--insecure Run without TLS. Use it to learn only.

The Core keeps its data in a synnax-data folder and its logs in a synnax-logs folder, in the folder where you ran the command. It listens on port 9090 of every network interface of the computer, so other computers on your network can reach it. Your firewall can ask you to allow the connection.

To stop the Core, press Ctrl+C in the terminal. For other flags, see the CLI reference. Before your team relies on the Core, work through the production checklist.

Step 3Open the Console and log in

The Core serves the Synnax Console to your web browser. When the Core starts without a license, its log prints the address to open.

  1. In a web browser on the same computer, go to http://localhost:9090.
  2. Enter the username synnax and the password seldon. These are the credentials of the root user of a new Core.
  3. Click Log in.

The Console shows This Core needs a license. The Core refuses all other requests until you activate a license.

The Console is also a desktop application for Windows and macOS. To use it, see Connect the Console.

Step 4Activate the license

  1. On the activation screen, click Copy fingerprint, then click Get a key. Log in to the portal.
  2. Select the license, enter a Machine name, and paste the fingerprint into Host hashes.
  3. Click Activate and download license key. Your browser downloads a .lic file.
  4. In the Console, click and select the .lic file.
  5. Click Activate. The Console shows Projects.

The Core stores the key in its data folder, so it stays active after a restart. To give the key at start instead, pass the file with --license-file:

synnax start --listen=localhost:9090 --insecure --license-file=synnax.lic

With Docker, add -e SYNNAX_LICENSE_KEY="$(cat synnax.lic)" to docker run instead. For more methods, see Activate a license.

Step 5Create a project

In the Console, click New project. The project opens, and you can create channels, plots, and schematics in it.

Next steps