Skip to content

Quickstart

This guide takes you from zero to a running service with a public HTTPS URL, using the web dashboard. Prefer the terminal? Every step has a CLI equivalent — see From the CLI at the end.

Sign up at bitsreef.com and verify your email. A personal organization is created for you automatically — you can add more later and invite teammates (see Teams & roles).

A project groups related services.

  1. From your organization’s dashboard, click New Project.
  2. Give it a name and open it. You land on the project canvas — the space where your services live.

The organization dashboard with a project

  1. On the project canvas, click Add Service.
  2. Enter a Service Name (e.g. web).
  3. Set Source Type to Container Image and enter an image — we’ll use nginx:latest.
  4. Set the Exposed Port your container listens on (80 for nginx).
  5. Click Create Service.

The Add Service panel with Source Type set to Container Image

BitsReef pulls the image, starts it, wires up routing, and provisions a TLS certificate. You can watch the deploy progress live on the service.

Open the service on the canvas to find its public URL and tabs for Deployments, Environment, Domains, Scaling, and logs. Click the URL — it’s served over HTTPS with a certificate BitsReef issued for you.

Everything above is available from the bitsreef CLI too — ideal for automation and CI:

Terminal window
# Install and log in
pipx install bitsreef-cli
bitsreef auth login --url https://v1.api.prod.bitsreef.com/v1
# Create-or-update a service and stream the deploy to completion
bitsreef up --project my-project --name web --image nginx:latest --port 80 --follow

bitsreef up exits non-zero if the deploy fails, so it drops straight into a pipeline. See the CLI reference for the full command set.