Getting Started

Public guide — no login required to read. Follow these steps to go from zero to a live preview URL on superbld.io.

1. Step 1

   Create an account

   Open the dashboard and sign up — no credit card, no YAML.

   • Google — one click OAuth
   • Email — we send a one-time code (OTP)

   Start here: app.superbld.io/login

2. Step 2

   Connect a repository

   In the dashboard, choose New Project and pick a source:

   • GitHub

     Paste a public clone URL, or connect your GitHub account when prompted. Push events trigger deploys via webhook.

   • Gitea

     Use our hosted forge at gitea.superbld.io, or any self-hosted Gitea/Forgejo URL. Create the repo there, then paste the clone URL into New Project → Gitea.

   You can also paste any public git URL if you prefer not to use the provider pickers.

3. Step 3

   Deploy

   After the project is created, click Deploy (or push to the tracked branch). Superbuild:

   • Clones the repo and detects your stack
   • Runs a containerized build with layer caching
   • Streams build logs live in the dashboard

   Cached builds aim for our north star: <15s.

4. Step 4

   Open your preview URL

   Every branch gets its own HTTPS preview on *.superbld.io:

   https://<branch>-<project>.superbld.io

   Share the link with teammates before merging. Path-based previews also work on self-hosted installs.

   Push again — Superbuild rebuilds and updates the same preview URL for that branch.