Quickstart

Sign in, connect GitHub, change one line, and watch your first job run.

About five minutes from nothing to your first job on RaftRun. You need a Google account and admin rights on the GitHub organisation or account whose repositories you want to run.

  1. Sign in

    Open the dashboard and sign in with Google. Your first sign-in creates a workspace with you as its admin. If someone invited you, open their invitation link instead and you join their workspace.

  2. Connect GitHub

    In Settings, press Connect a GitHub account. GitHub asks where to install the RaftRun app: choose the organisation, and all repositories or just the ones you pick. You come back to Settings with the account listed.

    The app reads workflow job events and registers runners. A job that doesn't ask for a RaftRun label keeps running where it does today, so installing it changes nothing on its own.

  3. Choose a plan

    On Plan & billing, pick a plan for the people in your workspace. Machine time is billed per minute on the same invoice, and a monthly spending cap of $50 is on by default. See Plans and billing.

  4. Change one line

    Pick a job and point its runs-on at a RaftRun label.

    .github/workflows/ci.yml
    jobs:
      test:
        runs-on: ubuntu-latest
        runs-on: raft-ubuntu-24.04
        steps:
          - uses: actions/checkout@v4
          - run: make test

    raft-ubuntu-24.04 is 2 vCPU and 4 GB. Need more? raft-ubuntu-24.04-4, -8 and -16 are bigger; Runner sizes lists them all.

  5. Push and watch

    Push the change. The job shows on GitHub as usual, and on the Jobs page of the dashboard with its size, time in the queue, duration, CPU and memory, steps and logs. A machine usually picks the job up well within a minute.

A Docker host too

On Docker hosts, create one with a name and your SSH public key, then point Docker at it. The full walk-through is in Get a Docker host.

your terminal
ssh-keyscan -p 2222 ssh.raftrun.com >> ~/.ssh/known_hosts
export DOCKER_HOST=ssh://my-laptop@ssh.raftrun.com:2222
docker run --rm hello-world

Next