Get started

This tutorial is for someone new to Veriom. You will create an account and a workspace, connect one GitHub repository, and open the results of its first audit.

You need:

• a work email address, or a GitHub account;
• permission to install a GitHub App on the GitHub account or organization that owns your repository.

1. Create your accountCopy Anchor Link

If someone invited you, open the link in your invitation email and follow it. Invitations expire after 7 days. Skip to step 2 if you joined an existing workspace.

Otherwise:

1. Go to veriom.ai/register.
2. Click Continue with GitHub, or enter your Work email and a Password and click Start free trial.
3. If you used email, Veriom shows Check your email. Open the link in that email. It works once and expires after 24 hours.

Passwords need at least 12 characters and three of these four: lowercase letters, uppercase letters, digits, and symbols.

If the page says Join with an invitation, Veriom is accepting invited users only. Click Request access, or ask a workspace admin to invite you.

2. Create a workspaceCopy Anchor Link

A workspace holds one system or team: its repositories, audits, findings, and members.

1. After you sign in, Veriom opens Set up your workspace.
2. In Workspace name, enter the name of the system you want to review, for example Customer platform.
3. Click Create workspace.

You are now the workspace Owner, and a 14-day Free Trial has started.

3. Connect a GitHub repositoryCopy Anchor Link

1. In the Connect your code step, click Choose GitHub repositories.
2. GitHub opens. Choose the account or organization, select the repositories Veriom may read, and click Install.
3. GitHub sends you back to Veriom. Choose which repositories to add.

Audits need read access to code and metadata. Pull request checks and fix pull requests need more. See Connect a repository for the full list of GitHub permissions, and for GitLab, Bitbucket, and ZIP uploads.

4. Watch the first auditCopy Anchor Link

Veriom starts an audit for each repository you connect. You do not need to press anything. The First audits panel shows each one, and Open audits shows them all.

An audit moves through these statuses:

After the first audit, each repository is audited again on every push to its default branch and on a weekly schedule.

To start an audit yourself, open Audits and click Start audit. Choose the repository and branch, then click Start audit.

5. Read the resultsCopy Anchor Link

When an audit shows Done, open these pages from the sidebar:

• Overview: what needs your attention first.
• Findings: each problem the audit found, with its severity and the evidence behind it. See Findings.
• Architecture: a map of your services, data stores, and connections, built from the code.

Next stepsCopy Anchor Link

• Invite your team: Members and roles.
• Add Veriom to your CI: Run Veriom in CI.
• Give audits more context: Connect your team's tools.
• Learn what an audit does: How audits work.