Skip to content
lighthouse
Menu

Get started

Get started

There is no account to create. You run the server, and each repo you onboard talks to it with a Build token and the server basicAuth pair.

Read the guideSign in to the server
  1. Step 1

    Have a server

    Deploy apps/server with a Postgres database, or use an LHCI server you already run. You need its URL and its server basicAuth pair.

  2. Step 2

    Build the toolkit

    In a checkout of the lighthouse repo, run pnpm install and pnpm build. lhci-toolkit is then available through pnpm --filter=@houses/lighthouse-cli exec lhci-toolkit.

  3. Step 3

    Register your repo

    Run lhci-toolkit --server-url <url> with --admin-username and --admin-password (the server basicAuth pair), then register <repo-name>. Save the Admin token it prints.

  4. Step 4

    Upload from CI

    Add upload.basicAuth and the Build token to the repo’s lighthouserc.js, set the three secrets in CI and run npx @lhci/cli autorun.

What you need

  • Access to the lighthouse repo: lhci-toolkit and the login helpers are built from it and are not on npm yet
  • Node.js and pnpm to build and run lhci-toolkit
  • A Postgres database for the server, if you deploy your own
  • The server URL and the server basicAuth pair
  • A repo with a CI pipeline (the docs use GitHub Actions)

About “Sign in”

The LHCI server has no user accounts. Sign in opens the server’s dashboard, and your browser asks for the server basicAuth pair. If you run your own server, use its URL instead.