Integrate GitHub with BoostSecurity¶
BoostSecurity lets you connect your GitHub organization and apply security checks, including CI/CD supply chain security checks and Dependabot.
Prerequisites¶
As a prerequisite to installing the application:
- Ensure that you have a GitHub organization and the following permissions in place.
Permissions¶
This integration will require the following permissions:
- Read access - Actions, Dependabot alerts, webhooks, administration, metadata, secret scanning alerts, workflows, and security events.
- Read & Write access - Checks, Issues, Pull Requests.
1. Connect GitHub to BoostSecurity¶
To install the GitHub App on your GitHub organization:
-
Go to Settings on the navigation panel and select Integrations;
Settings > Integrations
. -
Choose the GitHub integration from the Available section.
-
Click Install: You will be directed to the GitHub App to install the BoostSecurity GitHub App.
- Select the appropriate GitHub organization on your account you want to install the BoostSecurity GitHub App.
-
Choose whether to install the GitHub App on All repositories or Only select repositories.
Info
If you install the BoostSecurity app on All repositories, the access will apply to all current and future repositories. However, installing the app on Only select repositories would restrict BoostSecurity's access to just those repos. It is therefore recommended to install it for all repositories so that it is simpler to add the BoostSecurity security scanner to new repositories.
-
Click Install and Authorize.
Once the installation is completed, the BoostSecurity GitHub card is added to the Settings > Integrations > Installed
section. At this point, the BoostSecurity GitHub App is installed on your GitHub organization!!!
2. Enable Dependabot and Default Scanner Protection¶
It is recommended to enable default scanner protection and Dependabot for your GitHub organization after a successful integration.
To do this,
-
Go to the Scanner Coverage page and select the Default Scanner Protection column for your GitHub integration.
-
Toggle SBOM, SCA, or Secrets to enable the BoostSecurity Scanner default protection, and Dependabot to enable the scanner for your GitHub integration.