Skip to content
Security

Connecting GitHub

Install the GitHub App, grant repository access, and keep the connection in sync.

Installing the GitHub AppPermalink to Installing the GitHub App

Relane Security reads your code through a GitHub App installation. From the console, choose to connect GitHub and you are taken to GitHub to install the app onto an account or organization you administer.

During installation GitHub asks which repositories the app may access. You can grant access to selected repositories or to all of them; you can change this at any time from GitHub.

You need permission to install

Installing a GitHub App on an organization requires the right to do so on that organization. If you do not have it, GitHub asks the organization owners to approve the request.

Syncing repositoriesPermalink to Syncing repositories

After installation, the console imports the repositories the installation can reach. If you change the grant on GitHub — adding or removing repositories — run a sync so the console reflects the change.

A sync reconciles the list in both directions: repositories newly granted appear, and repositories whose access was withdrawn stop being scannable.

Where this happens in the console

When the installation is suspendedPermalink to When the installation is suspended

GitHub lets an administrator suspend an app installation without deleting it. While it is suspended, Relane Security can no longer read the repositories, and they show Access suspended in the console.

Existing scans and their results remain readable. New scans cannot start until access is restored from GitHub.