Skip to main content
Version: 1.4

Quick Start Guide

To get started, you need to:

  • Obtain the software, Harbor account credentials, and access to the documentation.
  • Ensure your workstation meets the hardware requirements.
  • Install the solution.

After successful installation, it is recommended to follow the algorithm of actions in the system presented below.

For the Administrator Role

  1. Perform the necessary system configuration:
  2. Configure security tools and scan sources.
  3. Configure notification tools in the system.
  4. Configure integration with a task tracker.
  5. Further administrator actions may also include some actions for the user role (see below).

For the User Role

Assuming successful system configuration by the administrator, users are advised to follow this workflow:

  • Create projects in the system. Projects should have clear names and brief descriptions. For each project, you need to:
    • Go to the Project Overview.
    • Add Security Pipelines.
    • Add Security Checks for each pipeline.
    • Add Quality Gates (if necessary; this can be added later when there are enough checks).
    • Also add Security Rules and Deduplication Rules for the project (if necessary; this can be added later when there are enough checks).
    • Then, start a scan (Security Pipeline or an individual check) for the project. Review the scan results. Based on the results, it is recommended to take steps to remediate the identified vulnerabilities, create tasks in the tracker if necessary, and then track the vulnerability fixes. It is also recommended to run new scans for verification.
    • Add necessary Response Rules. Generate required reports for one or several projects as needed.
  • Further actions depend on individual needs within the offered functionality.