Guides

Choose a task, follow the steps, and use the matching CLI or SDK reference when you need more detail.

New to Synq? Complete the quickstart first.

Deploy

Task	Guide
Deploy a repository	GitHub or any Git URL (GitLab, Bitbucket, Gitea, Forgejo, your own server)
Deploy files from your machine	Folders and archives
Run a prebuilt container image	Docker image
Deploy from a single file	Pasted Dockerfile or Compose file
Install a ready-made app	One-click apps and the templates catalog
Code in VS Code in the browser, on your server	Box: a dev environment
Start without your own repository	Templates and Git URLs
Choose how the image is built	Build detection and builders
Deploy code generated by an application	Generated code and source files
Run an app and its supporting services	Compose and multiple services
Deploy branches separately	Preview environments
Deploy on push	Automatic deployments
Deploy from CI or any tool	Deploy hooks
Find deployments, read logs, return to an earlier release	Deployments, rollback and redeploy

Task	Guide
Declare configuration in your repository	synq.json
Set environment variables and secrets	Environment variables
Add a hostname and HTTPS	Custom domains
Connect apps and databases privately	Internal networking
Open a TCP or UDP port, or expose a database	Public ports and database access
Keep data across deployments	Persistent and object storage
Create, back up, and restore named volumes	Volumes and volume backups
Mount a config file or certificate	File mounts
Set CPU and memory limits	Resources
Pin cores and set CPU priority	Dedicated CPU cores
Set the restart policy and Docker options	Container settings
Clone private repositories	Git authentication
Register a GitHub App	Self-hosted GitHub Apps

Task	Guide
Inspect traffic, logs, and health	Logs and monitoring
Schedule commands	Jobs
Protect and restore data	Backups and restores
Update and manage a WordPress site	WordPress tools
Take an app offline behind a notice	Maintenance mode
Connect an SSH server	Custom servers
Manage the reverse proxy	The edge
Update Synq	Updates
Manage access	Teams and members
Run mail and webmail	Email

Task	Guide
Give the panel a domain, move it, or set up domains for your apps	Domains for the panel and your apps
Back up Synq's own database	Back up and restore the panel
Free disk space on a server	Docker disk usage and cleanup
Protect sign-in with an authenticator app	Two-factor authentication
See who changed what	Audit log
Connect AI agents	MCP

Task	Guide
Import from another platform	Coolify, Dokploy, and Dokku
Move between servers	Server-to-server migration
Move Synq's own data	Control-plane migration
Run application schema changes	Database migrations

Build a catalog app or your own custom templates, integrate the SDK, call the HTTP API, or connect an MCP client.