Contact support

Tell us what you were trying to do and what happened. We reply by email.

Get started
Get started

Quickstart for admins

Set up Lighthouse for your team, from connecting GitHub to the first scanned commit.

Follow these steps once for your team. When you finish, your repositories are in Lighthouse, pull requests are scanned, and developers can start using it.

Who can do this:Team adminsIf you created the team from an invitation, you're an admin.

The Lighthouse Setup page in the dashboard tracks the same steps. Use it to see which ones are left.

Connect GitHub

Go to Settings › Git providers and press Connect GitHub. On GitHub, pick the organization and the repositories Lighthouse may read, then approve.

Connecting GitHub from Settings › Git providers.

Details: Connect GitHub.

Add a repository

Go to Repositories, press New repository, pick one from the list, and press Create repository.

Pull requests in that repository are scanned from now on. Details: Add repositories.

Run its first ingestion

Open the repository and press Run ingestion. Keep the default branch and the latest commit, then press Queue.

Ingestion reads the code and writes the repository's security cards. Small repositories take a few minutes. You don't need to keep the page open. Details: Run an ingestion.

Invite your developers

Go to Team › Members and press Invite member. Enter an email, pick a role, and choose which repositories they can see. Copy the join link and send it to them. It works once and expires after 48 hours.

Details: Invite members.

Issue their API keys

Go to Team › API keys and press Issue key. Set the developer as the owner. They reveal the key themselves, and you never see it.

Details: API keys.

Choose what blocks a merge

Go to Settings › Repository defaults. By default, a critical finding blocks a commit and a merge. Change it now if your team wants something stricter or looser.

Details: Blocking policy.

Next

Send your developers to the quickstart for developers. Once they run reware-lighthouse init, their commits are scanned too.

Dashboard shows No active plan

Your team needs a plan before Lighthouse can run ingestions or scans. Contact RewareLabs through Support at the top of this page.

Still stuck after reading this page?

Contact support

Tell us what you were trying to do and what happened. We reply by email.

On this page