# Guides
URL: https://synquic.tech/docs/guides.md

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](/docs/getting-started/quickstart) first.

## Deploy

| Task | Guide |
| --- | --- |
| Deploy a repository | [GitHub](/docs/guides/deploy-from-github) or [any Git URL](/docs/guides/deploy-from-git-url) (GitLab, Bitbucket, Gitea, Forgejo, your own server) |
| Deploy files from your machine | [Folders and archives](/docs/guides/deploy-local-folder) |
| Run a prebuilt container image | [Docker image](/docs/guides/deploy-docker-image) |
| Deploy from a single file | [Pasted Dockerfile or Compose file](/docs/guides/deploy-dockerfile-or-compose) |
| Install a ready-made app | [One-click apps](/docs/guides/one-click-apps) and the [templates catalog](/docs/reference/templates-catalog) |
| Code in VS Code in the browser, on your server | [Box: a dev environment](/docs/guides/dev-box) |
| Start without your own repository | [Templates and Git URLs](/docs/guides/deploy-template-or-url) |
| Choose how the image is built | [Build detection and builders](/docs/guides/build-detection) |
| Deploy code generated by an application | [Generated code and source files](/docs/api/sources) |
| Run an app and its supporting services | [Compose and multiple services](/docs/guides/compose-multi-service) |
| Deploy branches separately | [Preview environments](/docs/guides/preview-environments) |
| Deploy on push | [Automatic deployments](/docs/guides/auto-deploy) |
| Deploy from CI or any tool | [Deploy hooks](/docs/guides/deploy-hooks) |
| Find deployments, read logs, return to an earlier release | [Deployments, rollback and redeploy](/docs/guides/rollback-redeploy) |

## Configure

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

## Operate

| Task | Guide |
| --- | --- |
| Inspect traffic, logs, and health | [Logs and monitoring](/docs/guides/logs-monitoring) |
| Schedule commands | [Jobs](/docs/guides/jobs) |
| Protect and restore data | [Backups and restores](/docs/guides/backups-restore) |
| Update and manage a WordPress site | [WordPress tools](/docs/guides/wordpress) |
| Take an app offline behind a notice | [Maintenance mode](/docs/guides/maintenance-mode) |
| Connect an SSH server | [Custom servers](/docs/guides/custom-servers) |
| Manage the reverse proxy | [The edge](/docs/guides/the-edge) |
| Update Synq | [Updates](/docs/guides/updating) |
| Manage access | [Teams and members](/docs/guides/teams-members) |
| Run mail and webmail | [Email](/docs/guides/email-webmail) |

## Run your Synq server

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

## Move

| Task | Guide |
| --- | --- |
| Import from another platform | [Coolify, Dokploy, and Dokku](/docs/guides/migrate-from-coolify-dokploy-dokku) |
| Move between servers | [Server-to-server migration](/docs/guides/server-to-server-migration) |
| Move Synq's own data | [Control-plane migration](/docs/guides/migrate-control-plane) |
| Run application schema changes | [Database migrations](/docs/guides/database-migrations) |

## Extend

Build a [catalog app](/docs/guides/add-an-app) or your own [custom templates](/docs/guides/custom-templates), integrate the [SDK](/docs/api/sdk), call the
[HTTP API](/docs/api), or connect an [MCP client](/docs/mcp).