Links

GitHub

Choose your deployment method:

Step 1: Create a Bearer API token

  1. 1.
  2. 2.
    Go to Settings
  3. 3.
    Select API Tokens
4. Generate a token for the Broker
5. Copy and keep safe the token you generated, you will need it later in the configuration file.
You can't display a generated token twice. If you haven't saved it, you will need to generate a new one and revoke the one you lost.

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 👇
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
version: "3"
services:
bearer-broker:
image: bearersh/broker:latest
environment:
- BEARER_TOKEN=<your-bearer-token>
- GITHUB_TOKEN=<your-github-token>

Method 2: helm

$ helm install --set BEARER_TOKEN=<your-bearer-token> \
--set GITHUB_TOKEN=<your-github-token> \
--repo <https://bearer-helm-repo.s3.eu-west-1.amazonaws.com/> \
bearer-broker bearer-broker