Add A GitHub Service

In order to integrate GitHub with MetaDefender Software Supply Chain, please follow these steps:

  1. From the left side menu, navigate to Inventory and choose GitHub
  2. There are two ways to connect
  • Using a GitHub App: please omit step 4
  • Using a GitHub Personal Access Token
  1. Give your connection a name so you can easily identify it later.
  2. Enter your Access Token. Scroll to the end of this page for more details.
  3. Enter your App ID. Scroll to the end of this page for more details.
  4. Enter your Installation ID. Scroll down to the end of this page for more details.
  5. Enter your Private Key. Scroll down to the end of this page for more details.
  6. Select Add Connection in order to finish the process.

Where can I find the Access Token?

To generate an Access Token, please follow these steps:

  1. Log in to GitHub and go to Settings.
  2. Navigate to Developer Settings and from the left menu, select Personal access tokens, and then Tokens (classic).
  3. Click on Generate new token (classic).
  4. Give it a Note so you can easily identify it later.
  5. Set the Expiration to No expiration.
  6. The scopes required by MetaDefender Software Supply Chain are:
    • repo
      • repo:status
      • public_repo

By configuring an expiration date for temporary access (e.g., 30 days), the integration with MetaDefender Software Supply Chain will be operational exclusively for the specified duration. Once this period elapses, you will have to create a new token and update the connection.

Registering a new GitHub App

  1. Log in to GitHub and go to Settings.
  2. Navigate to Developer Settings from the left menu and click on New GitHub App.
  3. Fill in the required information for your app and configure the permissions your app requires for accessing repositories and performing actions.
  4. Once you have filled in all the details, click on the Create GitHub App button.
  5. Generate and download a private key for your app. This key will be used for authentication.
  6. On the app settings page, scroll down to the Install App section.
  7. Click on the Install button next to the repository where you want to install your app.
  8. Review the access permissions and click Install again to confirm.
  9. The GitHub App ID, GitHub App Installation ID, and the contents of the Private Key are required in order to see the connection.
  10. Navigate to Settings -> Developer settings and click on your GitHub App. Copy the App ID from here and provide it in the input field.
  11. Navigate to Install App, click on the configure icon and in the URL you will find the Installation ID (e.g. https://github.com/settings/installations/**{InstallationID}**).
  12. Copy the contents of your previously downloaded Private Key (including the headers) and paste them in the input field.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard