Project Management

How to Add Projects

When you click "Add Project", you will see 4 options:

Creating API Secrets (Required for CI/CD)

Before using CI/CD (GitHub Actions, GitLab CI/CD, or Jenkins), you need to create API Secrets.

Way 1: From Sidebar

1. Look at the Left Sidebar

   Find the navigation menu on the left side.

2. Click on "API Secrets"

   Click the API Secrets option in the sidebar.

3. Click "Generate New Secret"

   Click the button to create a new secret.

4. Enter a Name

   Give your secret a descriptive name.

5. Choose Expiration Time

   Select from: 7 days, 30 days, 60 days, 90 days, never, or custom.

6. Click "Generate"

   Generate your new API secret.

7. Copy and Save

   Copy your Client ID and Client Secret immediately.

Way 2: From CI/CD Option

1. Go to Projects Page

   Navigate to the Projects section.

2. Click "Add Project"

   Open the Add Project modal.

3. Choose "CI/CD"

   Select the CI/CD option.

4. Click "Create API Secret"

   Click the button shown below the CI/CD options.

5. Follow the Steps

   Complete the same steps as above to generate your secret.

Method 1: Using CI/CD

This method uses CI/CD tools to automatically create projects when you push code. Inside the CI/CD option, you will see 3 choices:

Option A: Using GitHub Actions

1. Go to Projects Page

   Navigate to the Projects section in NeoTrak.

2. Click "Add Project"

   Open the Add Project modal.

3. Choose "CI/CD"

   Select the CI/CD option from the 4 available methods.

4. Select "GitHub Actions"

   Choose GitHub Actions from the three CI/CD options.

5. Copy the Code Snippet

   You will see a code snippet displayed - copy this code.

6. Go to Your GitHub Repository

   Open your GitHub repository in a browser or IDE.

7. Create Workflows Folder

   Create or open the .github/workflows folder.

8. Create YAML File

   Create a new .yml file (e.g., neotrak.yml).

9. Paste the Code

   Paste the copied code into this file and save.

10. Add GitHub Secrets

    Go to Settings → Secrets and variables → Actions → New repository secret. Add the secrets shown in NeoTrak.

11. Run the Action

    Push your code or run the GitHub Action manually.

12. Project Created!

    Your project will be created automatically in NeoTrak!

Option B: Using GitLab CI/CD

1. Go to Projects Page

   Navigate to the Projects section in NeoTrak.

2. Click "Add Project"

   Open the Add Project modal.

3. Choose "CI/CD"

   Select the CI/CD option.

4. Select "GitLab CI/CD"

   Choose GitLab CI/CD from the options.

5. Copy the Code Snippet

   Copy the displayed code snippet.

6. Go to Your GitLab Repository

   Open your GitLab project.

7. Open .gitlab-ci.yml

   Create or open the .gitlab-ci.yml file in the project root.

8. Paste the Code

   Paste the copied code and save the file.

9. Add GitLab Variables

   Go to Settings → CI/CD → Variables. Add the secrets shown in NeoTrak.

10. Run the Pipeline

    Push your code or run the pipeline manually.

11. Project Created!

    Your project will be created automatically in NeoTrak!

Option C: Using Jenkins

1. Go to Projects Page

   Navigate to the Projects section in NeoTrak.

2. Click "Add Project"

   Open the Add Project modal.

3. Choose "CI/CD"

   Select the CI/CD option.

4. Select "Jenkins"

   Choose Jenkins from the options.

5. Copy the Code Snippet

   Copy the displayed Jenkinsfile code.

6. Create Jenkinsfile

   Create a Jenkinsfile in your project root.

7. Paste the Code

   Paste the copied code and save the file.

8. Configure Jenkins Credentials

   Go to Manage Jenkins → Credentials. Add the required credentials shown in NeoTrak.

9. Create Jenkins Job

   Create a new Jenkins job or pipeline pointing to your repository.

10. Run the Job

    Execute the Jenkins job.

11. Project Created!

    Your project will be created automatically in NeoTrak!

Method 2: Connect Your GitHub Account

This method lets you directly connect your GitHub account and import projects from your repositories.

1. Go to Projects Page

   Navigate to the Projects section.

2. Click "Add Project"

   Open the Add Project modal.

3. Choose "GitHub"

   Select the GitHub option (you will see GitHub icon).

4. Click "Connect GitHub"

   Click the Connect GitHub button.

5. Login to GitHub

   You will be redirected to GitHub login page.

6. Authorize NeoTrak

   Click "Authorize" to give NeoTrak permission to access your repositories.

7. Return to NeoTrak

   After authorization, you will return to NeoTrak.

8. Select Account/Team

   Choose your GitHub Account or Team from the list.

9. Click "Next"

   Proceed to repository selection.

10. Select Repository

    Choose the repository you want to import.

11. Click "Next"

    Proceed to branch selection.

12. Select Branch

    Choose the branch (main, master, dev, etc.).

13. Click "Create Project"

    Finalize the project creation.

14. Done!

    Your project is created and you can see all the security details.

Method 3: Connect Your GitLab Account

This method lets you directly connect your GitLab account and import projects from your repositories.

1. Go to Projects Page

   Navigate to the Projects section.

2. Click "Add Project"

   Open the Add Project modal.

3. Choose "GitLab"

   Select the GitLab option (you will see GitLab icon).

4. Click "Connect GitLab"

   Click the Connect GitLab button.

5. Login to GitLab

   You will be redirected to GitLab login page.

6. Authorize NeoTrak

   Click "Authorize" to give NeoTrak permission to access your projects.

7. Return to NeoTrak

   After authorization, you will return to NeoTrak.

8. Select GitLab Group

   Choose your GitLab Group from the list.

9. Click "Next"

   Proceed to repository selection.

10. Select Repository

    Choose the repository you want to import.

11. Click "Next"

    Proceed to branch selection.

12. Select Branch

    Choose the branch (main, master, dev, etc.).

13. Click "Create Project"

    Finalize the project creation.

14. Done!

    Your project is created and you can see all the security details.

Method 4: Upload File Directly

This is the simplest way to add a project by manually uploading a file.

1. Go to Projects Page

   Navigate to the Projects section.

2. Click "Add Project"

   Open the Add Project modal.

3. Choose "Upload File"

   This option is selected by default.

4. Fill Project Details

   Enter: Project Name (Required), Version (Optional), Description (Optional), Tags (Optional).

5. Upload Your File

   Drag and drop your file or click to browse and select from your computer.

6. Select File Type

   Choose the type from dropdown: SBOM, Java, Python, etc.

7. Click "Add"

   Submit the form to create the project.

8. Wait for Upload

   Wait while the file uploads and is analyzed.

9. Done!

   Your project is created and you can see all the security analysis.

Projects Page Overview

The Projects Page displays a comprehensive list of all projects within the current workspace.

Key Metrics Displayed

Project List Table Columns

Actions Available Per Project

• Refresh - Triggers a new scan, re-analyzes for vulnerabilities, updates dependency information
• Delete - Removes the project (soft delete), requires confirmation

Additional Features

• Sort Options - Sort in Ascending (ASC) or Descending (DESC) order
• Download Button - Export all projects data to Excel (.xlsx) file including project name, version, vulnerability counts, EOL findings, and last scan date

Project Details Page

When you click on a Project Name from the projects list, you navigate to the Project Details Page which provides comprehensive information about the selected project.

Top Action Buttons

Project Details Tabs

1. Services Tab

Displays all products/services associated with the project, both auto-detected and manually added.

2. Components Tab

Lists all software components and dependencies with vulnerability information.

Filter Options: Severity Filter, Outdated Version Filter, Vulnerability Filter

Auto Update: Choose Major, Minor, or Both version updates to generate an updated SBOM or dependency file.

3. Issues Tab

Shows all security vulnerabilities with CVE/GHSA IDs, severity, descriptions, and remediation advice.

4. Secrets Tab

Displays detected secrets and sensitive information in the codebase.

5. Config Issues Tab

Shows configuration-related security issues and misconfigurations.

Expanded rows show: Severity, Description, Resolution steps, and Suppress button for false positives.