GitHub App

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

The organization's GitHub App installation is what lets Proliferate cloud workspaces reach your repositories. The installation is owned by the organization, but a member's effective access to any repository still depends on their own GitHub identity and permissions (see Per-member authorization and effective access below).

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

Install the app

Info:

Authorize your own GitHub identity first. The installation callback refuses to bind the installation to your organization unless the acting admin has already authorized their GitHub identity, so do this before you install.

Authorize your GitHub identity

The acting owner or admin authorizes their own GitHub identity from Account settings first. The installation step below cannot complete without it.

Start the install from Organization settings

Open the GitHub App section and click Install. Proliferate hands off to GitHub. Members do not have access to this Organization settings section.

Choose the account and repositories on GitHub

On GitHub, pick the account or organization to install into, and grant access to all repositories or a selected set. That grant sets which repositories the installation covers — it doesn't make any of them available to members on its own; each member still needs their own GitHub authorization and their own GitHub permission on a repo (see below).

Return to Proliferate

GitHub redirects back through a callback and the section shows an Installed status badge and the account it's installed on.

Per-member authorization and effective access

The organization installation is only one input. Repository access is per user: each member separately authorizes their own GitHub identity from Account settings before they can use cloud repositories. Installing the app for the organization does not authorize any individual — every member does this once for themselves.

A member's effective access to a repository 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, the button becomes Manage, which opens the installation on GitHub to change the repository selection or repair access. If the installation is suspended or repositories stop appearing, an admin uses the same path to reconnect it.

Info:

Self-hosted deployments create and register their own GitHub App rather than connecting a hosted one. That setup lives in the deployment docs: GitHub App for cloud sandboxes.

On this page