​

Complete User Guide

This guide will walk you through the entire process of using our platform, from registration to managing security vulnerabilities.

​

1. User Registration

There are two ways to register for an account:

​

Form Registration

1. Navigate to the registration page.
2. Fill out the required fields:
   • Email Address
   • Password
3. Click the “Register” button.
4. After successful registration, check your email for a verification link.

​

Google Account Registration

1. Click on the “Login with Google” button.
2. Select your Google account or enter your Google credentials.
3. Grant the necessary permissions.
4. Your account will be created using your Google information.

​

2. Email Verification

After registering with the form method, you need to verify your email address.

​

Verification Process

1. Check your email inbox for a message from us.
2. Open the email and click on the verification link.
3. You will be redirected to a confirmation page.
4. Click “Continue” to proceed to the login page.

​

3. Initial Account Setup

After logging in for the first time, you’ll need to complete the initial setup process.

​

4. Connectors

Connectors allow you to integrate your Source Code Management (SCM) systems with our platform.

​

Adding an SCM Connector

1. Navigate to the Connectors page.
2. Click on “Add Connector”.
3. Choose your SCM from the available options:
   • GitHub
   • GitLab
   • Bitbucket
   • Gitea (Soon)
4. Follow the authentication process for your chosen SCM.
5. Grant the necessary permissions to allow our platform to access your repositories.

​

5. Applications

The Applications page allows you to manage your repositories and create applications for security scanning.

​

Creating an Application

1. Go to the Applications page.
2. Click on “Add Applications”.
3. Select the SCM connector you want to use.
4. Choose the repository you want to add as an application.
5. Configure the application settings:
   • Application name
   • Branch to scan
6. Click “Create selected repositories” to finalize the application setup.

​

6. Pipeline Setup

The pipeline determines how and when your applications are scanned for vulnerabilities.

​

Configuring Your Pipeline

1. Navigate to the Pipeline Setup page.
2. Select the application you want to configure.

​

7. Findings

The Findings page displays all the vulnerabilities and issues detected by your security scans.

​

Filtering Findings

You can use various filters to focus on specific types of findings:

1. Click on the “Filter” button.
2. Apply filters based on:
   • Severity (Critical, High, Medium, Low)
   • Type of vulnerability
   • Repositories
   • Date range
   • Status
3. Click “Apply Filter” to update the findings list.

​

Reviewing a Finding

1. Click on a finding to view its details.
2. Review the description, affected code, and potential impact.
3. Assign the finding to a team member if needed.

​

8. Remediation

The remediation process helps you address and fix the security vulnerabilities found in your applications.

​

Creating a Remediation

1. From the Findings page, select a vulnerability you want to address.
2. Click on “Create Remediation”.
3. It will show the remediation type:
   • Pull Request
   • Issue
4. If choosing a manual fix:
   • Describe the proposed changes
   • Assign the task to a team member
   • Set a due date
5. Click “Create Pull Request” / “Create Issue” to initiate the remediation process.

​

Conclusion

By following this guide, you’ve learned how to:

1. Register and verify your account
2. Set up your organization’s profile
3. Connect your SCM systems
4. Create and manage applications
5. Configure security scanning pipelines
6. Review and filter security findings
7. Create and manage remediations

Remember to regularly review your findings and create remediations to maintain a strong security posture. If you need any further assistance, don’t hesitate to contact our support team.