Skip to content

First run

A fresh install has no user. The API creates nothing by itself: the first person to open the setup link becomes the administrator.

Open the setup link the install printed, for example http://localhost:8000/setup?token=…, choose your name, email and password, and you are signed in right after.

The link works once, and only while Nautelle has no user. Each start of the API logs a new one and the older one stops working. To find the current link:

Terminal window
cd nautelle
docker compose logs api | grep -o 'http[^ ]*/setup?token=[^ ]*' | tail -n 1

For an install nobody opens a browser on, pass the administrator to the install instead:

Terminal window
curl -fsSL …/install.sh | sh -s -- --admin-email you@example.com --admin-password '…'

The API creates that account on its first start. install.sh hands the two values to that start only and writes neither into .env.

  • Pair a runner: the machine where your agents work.
  • Connect a project: a repository for the Board.
  • Invite people: they register on the sign-in page, and an administrator approves each account under Admin › Users.

Why the first administrator is created this way: ADR-0087.