ProliferateDocs
Join the beta

GitHub App

Connect the organization's GitHub App so Proliferate can reach your repositories.

The GitHub App installation is what lets Proliferate reach your GitHub repositories. The organization owns it, but a member's effective access still depends on their own GitHub identity and permissions — see below.

Scope
Who can do itOwners and admins; Organization settings are admin-only
Applies toGitHub-backed repositories
RequirementA team organization
AffectsThe organization (installation) and the repositories it can reach

Install the app#

Note

Authorize your own GitHub identity first. The callback refuses to bind the installation unless the acting admin has already done so.

Authorize your GitHub identity#

Authorize your own GitHub identity from Account settings. The install cannot complete without it.

Start the install from Organization settings#

Open the GitHub App section and click Install. This section is admin-only.

Choose the account and repositories on GitHub#

Pick the account or organization, and grant all repositories or a selected set. That sets what the installation covers. It does not make any repo available to a member — each still needs their own GitHub authorization and permission.

Return to Proliferate#

GitHub redirects back and the section shows Installed with the account.

Per-member authorization and effective access#

The installation is only one input. Every member authorizes their own GitHub identity from Account settings before they can use GitHub-backed repositories; installing the app does not do that for anyone.

Effective access is the intersection of three things:

  • Installation coverage — the repositories the org's installation was granted (all or the selected set).
  • The member's own GitHub authorization — they must have authorized their GitHub identity in Proliferate.
  • Their GitHub permissions — what that GitHub account is allowed to do on the repository.

Reconnect or repair#

Once installed, Manage opens the installation on GitHub to change the repo selection or repair access. It is also the path to reconnect a suspended installation.

Note

Self-hosted deployments register their own GitHub App rather than connecting a hosted one. That is part of the cloud sandboxes add-on, coming soon.