Quick start
From GitHub repo to live URL in three minutes.
1. Link your GitHub
/connected-accounts → Link GitHub. Suzko asks for read access to repos you select.
2. Create the project
/tools/deploy → New project.
- Source: GitHub
- Repo: pick from the list
- Branch: usually
main - Name: becomes part of the auto subdomain
- Region: closest to your users
Click Deploy.
3. Watch it build
The build logs stream live. Most projects build in 1–3 minutes.
What's happening:
- We clone the repo.
- We detect the framework (or use your
deploy.json— see deploy.json reference). - We install dependencies.
- We run the build command.
- We start the container with the start command.
- Traefik routes traffic at the subdomain.
4. Visit the URL
When the status flips to Running, the Open button next to the URL works. You should see your app.
5. (Optional) Custom domain
Project → Domains → Add domain. Enter the domain you want. We'll show you a CNAME record to add at your DNS. Once it propagates, we issue a Let's Encrypt cert automatically.
See Custom domains.
6. (Optional) Env vars
Project → Variables. Add key/value pairs. Container restarts to pick them up.
7. (Optional) Attached services
Project → Services → Add service. Pick from Postgres, MySQL,
Redis, MongoDB, RabbitMQ, more. Suzko provisions it, injects the
connection string as DATABASE_URL (or similar), restarts your
container.
That's the full loop. Your code in GitHub, your URL live, your DB attached. Push to your branch → we redeploy.