Run and maintain Synq

Use these commands on the machine that runs Synq. To manage an existing remote installation, configure a connection context instead.

Start

synq

On a fresh machine, the interactive command guides setup. On an installed machine, it opens the control panel or resumes an interrupted setup.

For direct startup:

synq up
synq status
synq open

up installs or starts a persistent service. status reports local service state and the active context's API health. open opens the dashboard. Use synq up --foreground for an attached process. See all startup options, including Docker Compose configuration.

Stop and update

synq stop           # on the server (sudo synq stop on a server installed with the installer)

stop disables the service so it stays stopped across reboot. To update, run the installer again with your license key; it upgrades the CLI and the images together. Read updating Synq before updating a production installation.

Move the panel to a domain

synq panel-domain                                                # show the panel's address
synq panel-domain panel.example.com --email you@example.com      # serve the panel on https://panel.example.com

Run it as root on the server (sudo). It checks DNS, issues the certificate before anything moves, and returns the panel to its old address if the new one doesn't come up. See Move the panel to a domain later.

Diagnose a problem

synq doctor

The doctor reference describes health and repair options. Local admin account recovery uses reset-admin-password.

Installation commands compared

See installation for server requirements and command options before removing or repairing an installation.