Getting started

This page takes a new Midair instance to its first test run and its first analysis run.

Sign in

Open the address of the instance in a browser. The sign-in screen asks for a login or an e-mail address, and for a password.

The same field also accepts a one-time code. Press Send OTP to receive a code by e-mail, and type that code in place of the password. The instance sends the code only after an administrator configures the mail server. See Integrations.

Create account opens the registration screen. It asks for a login and an e-mail address, and it sends a one-time code to that address. Type the code to finish. Registration needs a configured mail server.

The setup wizard

An administrator sees the setup wizard at the first sign-in. The wizard asks six questions. You can skip each step, and each screen behind it stays reachable afterwards.

  1. Welcome — what the three areas do.

  2. Account — your name, your login and a new password.

  3. Notifications — the mail server that Midair sends from. Midair sends one-time codes and comment notifications through it.

  4. Project — this step makes the first workspace. It asks for the machine that does the work, and for the repository to work on. Choose This machine to run everything on the server itself, or Another host and give an address. Check access tests the repository credentials before the wizard saves them.

  5. Builds — the products to download into the local registry: the analyser, the test environment, and the monitoring agent. Midair records the checksum of each file, so later runs deploy the same bytes. See Distributions.

  6. Ready — the wizard ends.

The wizard appears once. Use the ordinary screens to change anything that you skipped.

Add a node

A node is a machine that runs the work. Open Nodes, and press the button that adds a node.

The wizard asks for an address, a login and an authentication method. It then opens a connection and reports what the node answers. Give the node the roles that it is to carry: testing, analysis, or monitoring relay.

The server itself is a valid node. Enter localhost as the address. Midair then gives each run its own working copy under $HOME/.cache/midair/runs/, so two runs of one workspace do not write over each other.

See Nodes for the connection options.

Add a workspace

Open Workspaces, and press the button that adds a workspace. The wizard asks for a name and for the repository of the product.

A workspace that runs tests needs two more repositories: the test suite, and the test environment that the suite builds against. Open the workspace and fill in the three repository blocks. See Workspaces.

Run the first test

  1. Open Testing, then Templates, and add a template. A template holds the name, the run parameters and the notes. What runs, and where, comes from the workspace.

  2. Press the button that starts the template. Midair makes a new run record and opens it.

  3. The run screen shows the state, the log and the result tree. The states are queued, running, analyzing, finished and failed.

See Testing.

Run the first analysis

  1. Open Analysis, then Templates, and add a template. Select the jobs to run: defects, dependency, authorship, SBOM, metrics.

  2. Press the button that starts the template.

  3. Open the finished run. The findings viewer shows the source tree on the left, and the file with the findings under the lines that they refer to.

An analysis run needs an analyser build in the registry, and a node that carries the analysis role.

See Analysis.

What to do next