GitHub Enterprise

Step 1: Create a Bearer API token

  1. 1.
  2. 2.
    Go to Settings > Git Broker.
  3. 3.
    Copy and save the Git Broker token somewhere safe👇.
Generating a new token will not break the original connection right away.
There is a grace period during which the original connection is still functional while you deploy the Broker with your new token.

Step 2: Create a GitHub personal access token

For Bearer to perform the required actions, the user account creating the personal access token needs the Read permissions on the repositories you wish to scan.
Bearer acts on behalf of the user account who created the personal access token. We recommend that you create a dedicated Service Account for Bearer, invite it to join your organization, and grant it access to the code repositories you wish to scan with the permission Read.
Create a personal access token 👇
Creating a personal access token - GitHub Docs
GitHub Docs
Select the scope: repo

Step 3: Deploy the Broker

We recommend 1 vCPU and 1 GB of RAM to run one Broker.
You can speed up the scan of your repositories by deploying multiple brokers. We support up to 100 simultaneous brokers.

Method 1: docker-compose.yml

A Docker image is available on Docker Hub: bearersh/broker:latest
1
version: "3"
2
services:
3
bearer-broker:
4
image: bearersh/broker:latest
5
environment:
6
- BEARER_TOKEN=<your-bearer-token>
7
- GITHUB_TOKEN=<your-github-token>
8
- GITHUB_BASE_URL=<your-github-instance-url>
Copied!

Method 2: helm

1
$ helm install --set BEARER_TOKEN=<your-bearer-token> \
2
--set GITHUB_BASE_URL=<your-github-instance-url> \
3
--set GITHUB_TOKEN=<your-github-token> \
4
--repo https://bearer-helm-repo.s3.eu-west-1.amazonaws.com/ \
5
bearer-broker bearer-broker
Copied!
Once the Broker has been detected, its status will be updated in your dashboard 👇
Last modified 2mo ago