CLI Reference
Find information about the Synnax Core CLI.
Start
The start command starts the Synnax Core.
Examples
Starting a Core
We can use the i and m flags to start a Core in insecure mode with an in-memory data
store:
synnax start -l localhost:9090 -imFlags
Environment Variable Equivalents
The following environment variables can be used in place of the corresponding flags. Command line flags will take precedence over environment variables.
Configuration Files
Synnax will also read configuration files in JSON, TOML and YAML formats. The values set in these configuration files take the lowest precedence and will be overridden by any environment variables or command line flags.
By default, Synnax will look for a configuration file at ~/.synnax.yaml. You can
specify a different configuration file using the --config flag or the SYNNAX_CONFIG
environment variable.
Here are example configuration files in various formats:
{
"listen": "localhost:9090",
"peers": ["localhost:9091", "localhost:9092"],
"data": "/usr/local/synnax/data",
"verbose": true,
"insecure": false,
"mem": false,
"config": "/usr/local/synnax/config.yaml",
"certs-dir": "/usr/local/synnax/certs",
"ca-cert": "ca.crt",
"node-cert": "node.crt",
"node-key": "node.key",
"username": "synnax",
"password": "seldon",
"license-key": "000000-00000000-0000000000",
"debug": false,
"slow-consumer-timeout": "2.5s",
"no-driver": false,
"disable-integrations": [],
"enable-integrations": [],
"task-op-timeout": "60s",
"task-poll-interval": "1s",
"task-shutdown-timeout": "30s",
"task-worker-count": 4,
"log-file-path": "./synnax-logs/synnax.log",
"log-file-max-size": 50,
"log-file-max-backups": 5,
"log-file-max-age": 30,
"log-file-compress": true,
"disable-channel-name-validation": false
}listen: localhost:9090
peers:
- localhost:9091
- localhost:9092
data: /usr/local/synnax/data
verbose: true
insecure: false
mem: false
config: /usr/local/synnax/config.yaml
certs-dir: /usr/local/synnax/certs
ca-cert: ca.crt
node-cert: node.crt
node-key: node.key
username: synnax
password: seldon
license-key: 000000-00000000-0000000000
no-driver: false
disable-integrations: []
enable-integrations: []
task-op-timeout: 60s
task-poll-interval: 1s
task-shutdown-timeout: 30s
task-worker-count: 4
log-file-path: ./synnax-logs/synnax.log
log-file-max-size: 50
log-file-max-backups: 5
log-file-max-age: 30
log-file-compress: true
disable-channel-name-validation: falselisten = "localhost:9090"
peers = ["localhost:9091", "localhost:9092"]
data = "/usr/local/synnax/data"
verbose = true
insecure = false
mem = false
config = "/usr/local/synnax/config.yaml"
certs-dir = "/usr/local/synnax/certs"
ca-cert = "ca.crt"
node-cert = "node.crt"
node-key = "node.key"
username = "synnax"
password = "seldon"
license-key = "000000-00000000-0000000000"
no-driver = false
disable-integrations = []
enable-integrations = []
task-op-timeout = "60s"
task-poll-interval = "1s"
task-shutdown-timeout = "30s"
task-worker-count = 4
log-file-path = "./synnax-logs/synnax.log"
log-file-max-size = 50
log-file-max-backups = 5
log-file-max-age = 30
log-file-compress = true
disable-channel-name-validation = falseVersion
The version command prints the installed version of the Synnax database.
Examples
If you run this command:
synnax versionYou’ll see output similar to the following:
Synnax v0.51.2Flags
This command has no flags.
Service (Windows Only)
The service command manages Synnax as a Windows Service. These commands are only
available on Windows and require administrator privileges.
When running as a Windows Service, Synnax will:
- Start automatically when Windows boots (if configured)
- Receive proper shutdown signals for graceful termination
- Log events to the Windows Event Log
- Automatically restart on failure
service install
Installs Synnax as a Windows Service. Server configuration flags are stored in the service configuration and used when the service starts.
Examples
Install with default settings (auto-start enabled, insecure mode):
synnax service install --insecureInstall with custom data directory and listen address:
synnax service install --listen 0.0.0.0:9090 --data C:\ProgramData\Synnax\data --insecureInstall without auto-start:
synnax service install --auto-start=false --insecureFlags
service uninstall
Removes the Synnax Windows Service. This will stop the service if it is running and remove it from the system.
synnax service uninstallservice start
Starts the installed Synnax Windows Service.
synnax service startservice stop
Stops the running Synnax Windows Service.
synnax service stop