First Tasks on the UI

Configure your first scan

  1. Open the UI.

    1. Open the OpenClarity UI in your browser at http://localhost:8080/. The dashboard opens.

    2. (Optional) If needed, you can access the API at http://localhost:8080/api. For details on the API, see the API reference.

    OpenClarity UI
  2. Click on the Scans icon. In the Scans window, you can create a new scan configuration.

    OpenClarity UI Scan
  3. Click New scan configuration.

    OpenClarity Scan Setup - Step 1
  4. Follow the steps of the New scan config wizard to name the scan, and optionally narrow the scope down with an OData query.

    OpenClarity Scan Setup - Step 2
  5. Enable the scan types you want to perform.

    OpenClarity Scan Setup - Step 3
  6. Select the time and/or frequency of the scans. To run the scan immediately, select Now.

    OpenClarity Scan Setup - Step 4
  7. Optionally, adjust the number of scanners to run in parallel and whether to use spot instances on cloud providers, or not.

    OpenClarity Scan Setup - Step 5
  8. Click Save. The new scan appears on the Scan Configurations tab.

    OpenClarity Scan Config Summary
  9. Once a scan is finished, you can browse around the various OpenClarity UI features and investigate the security scan reports.

    OpenClarity Dashboard with Findings