Skip to main content
A workspace is your organisation’s space in Earnie. It holds your projects, your members and their roles, and the audit history of every decision made in it. This page covers three things:

Before You Begin

To sign in, you need to be a member of the workspace already. Earnie doesn’t create an account the first time someone signs in through single sign-on (SSO). An Admin adds you first, as described in Adding People to Earnie. To run the setup wizard, you need to be the workspace’s first administrator: the person SCANOSS set up when it created your workspace, or the person set as the first administrator when your organisation installed Earnie. You also need access to your code:
  • GitHub: owner rights on the GitHub organisation that holds the repository. If you aren’t an owner, the wizard gives you a link to send to an owner, so they can finish the connection.
  • GitLab: a group, project, or service account access token with the api and read_repository scopes, and the Maintainer role on the projects you want to scan.
Connecting a repository explains these permissions in detail.

Adding People to Earnie

An Admin gives each person access by adding them as a member:
  1. Go to Settings, then the Members tab.
  2. Select Add member.
  3. Enter the person’s Email. Use the address they sign in with at your identity provider, so Earnie can recognise them.
  4. Choose their Role: Admin, Operator, or Viewer. Team & roles explains what each role can do.
  5. Select Add member.
The person can now sign in. There’s nothing else for them to set up: send them your Earnie address, and they sign in with SSO.

Signing In

  1. Open your Earnie address in a browser.
  2. On the Sign in to Earnie page, select Sign in with corporate SSO.
  3. Earnie redirects you to your organisation’s identity provider, the service your company uses to manage logins. Sign in there as you normally do.
The identity provider sends you back to Earnie, and you’re signed in. The Sign in to Earnie page If sign-in fails even though you signed in at your identity provider, you probably aren’t a member of the workspace yet. Ask an Admin to add you with the email address your identity provider uses.

After You Sign In

Where you land depends on who you are and how you arrived:
  • The first administrator goes to the setup wizard each time they sign in, until they finish or skip it.
  • If you opened a link to a specific Earnie page while signed out, for example from a pull request comment, Earnie takes you to that page after you sign in.
  • Everyone else goes to the last project they viewed, or to All Projects. If your organisation has only one project, you go straight into it.
Until setup is complete, the sidebar shows a Finish setup card with the remaining steps, such as running the first scan or setting up a policy. It stays until the steps are done or you dismiss it with its close button.

The Setup Wizard

Welcome to Earnie The setup wizard takes the first administrator through six steps. When it ends, Earnie is connected to GitHub or GitLab, your first project exists, and its first scan is running. Other members never see the wizard. The rail on the left, Set up your workspace, lists the steps and ticks the ones you’ve completed: You can leave the wizard and come back. Earnie reopens it at the first step you haven’t completed. Once the first scan has started, it reopens at Add members. Skip setup, at the top right, ends the wizard at any point. So does finishing it. Either way, the wizard doesn’t open again, and you complete any remaining steps from the Finish setup card in the sidebar.

1. Welcome

The first screen explains what the wizard builds: one governed inventory of all your code, with what Earnie’s scanners find in it. Under Where your code lives, select the GitHub or GitLab card, then select Connect GitHub or Connect GitLab. If that provider is already connected, the button reads Continue and takes you straight to step 3.

2. Connect a Provider

Install Github AppEarnie reads your code through a GitHub App, which a GitHub organisation installs to give a service limited access to its repositories. Earnie’s access to your source code is read-only and covers only the repositories you choose. It can also comment on pull requests and post checks, so it reports its results where your team reviews code.Before you grant anything, Earnie lists the permissions it asks for: read access to repository contents and metadata, read and write access to pull requests, and write access to checks. To connect:
  1. Authorise Earnie so it can see which GitHub organisations you belong to. Select Connect GitHub, then copy the code Earnie shows, select Open GitHub, and enter the code there.
  2. Choose the organisation that will own the connection. The list shows whether you’re an owner or a member of each one, and also offers your personal account.
  3. Create the app. Select Create app for your organisation. Earnie creates a private Earnie app for it on GitHub. If you aren’t an owner of the organisation, you can’t create the app. Earnie gives you a hand-off link to send to an owner instead. The link works once and lets the owner finish the setup without an Earnie account.
  4. Install the app. Select Install on GitHub, and choose the repositories Earnie may read.
After you install the app, the wizard moves to the next step on its own.If Earnie says GitHub sign-in isn’t configured, your Earnie installation is missing a setting. Ask whoever installed Earnie. See GitHub.com in Installing Earnie.

3. Select Repository

In this step you create your first project: the codebase Earnie governs, together with its scans, decisions, and rules.
  1. Pick the repository this project will govern. The list shows the repositories the connection can reach. Use Filter repositories to find one.
  2. Name the project. Earnie fills in the repository’s name when you pick it. You can change it and add a description.
  3. Choose what the first scan runs.
    • Scanners analyse the source code itself: OSS matching, Cryptography, and AI provenance, depending on what your organisation has. Earnie selects all of them. You can turn any off, but at least one must stay on. If your organisation has only one scanner, this choice doesn’t appear. See AI provenance for what the AI scanner identifies.
    • Download Git LFS models appears when AI provenance is on. It controls whether Earnie fetches model files stored in Git LFS so it can identify them. Keep the project preference, which is off for new projects, or download or skip for this scan only. Downloads use the repository owner’s Git LFS bandwidth quota.
    • Intelligence layers add data to what the scanners find: Vulnerabilities and License. Both are on. Turning one off makes the first scan finish sooner, and you can re-run a scan with more layers at any time.
  4. Select Continue.
If the repository you want isn’t in the list, the connection can’t reach it. On GitHub, grant the Earnie app access to it in the app’s settings on GitHub. On GitLab, give the token access to its group or project, with the Maintainer role.

4. First Scan

First Scan The first scan starts on its own as soon as Earnie imports the repository, so you have nothing to do in this step. You don’t need to wait for the scan to finish. It keeps running in the background while you complete the last two steps, and a progress strip shows how far it has got. If the scan fails, retry it from the progress strip.

5. Add Members (Optional)

Add Members Add the people who will triage findings, meaning they review each finding and record a decision about it. For each person, enter their email address and choose a role: Admin, Operator, or Viewer. The role starts as Operator. Team & roles explains what each role can do. Developers and coding agents don’t need to be members. They use Earnie through pull requests, CI, the CLI, and the API. Add people with the email address they sign in with at your identity provider. They can sign in with SSO as soon as you add them. You can skip this step and add members later, as described in Adding People to Earnie.

6. Starter Policy (Optional)

Starter Templates A policy is a rule that tells Earnie what to do when a scan finds something, for example to block a merge that introduces a banned licence. Earnie provides policy templates for common rules. Each template shows the action it applies, such as warn or block. Pick one or more templates to begin with. A template is the quickest way to see the merge gate, Earnie’s pass or fail check on a change, work from start to finish. Policies you turn on here are enabled immediately. Templates you add later from a project’s Policies page start as drafts instead. Select Enable policy & finish, or Enable 2 policies & finish and so on if you picked more than one. To continue without a policy, select Skip for now. Earnie then opens the results of your first scan. If you skip this step, you can write policies later, as described in Setting policies.

What’s Next

Your first scan is now running. Next: