Start here
Install the private prpl Defender GitHub App
Document the owning-account restriction, repository selection, permissions, and installation verification.
org admin
capture: github-app-install
Outcome
The private prpl Defender GitHub App (prpl-private) is installed on your
GitHub account or organization with the repositories you chose, and you can
verify and manage the installation from GitHub's settings.
Who can do it
This App is private — only its owning account can install it.
prpl-private is not published on the GitHub Marketplace. GitHub restricts a
private App's installation to the account that owns the App, so the install
page returns 404 Not Found for everyone else. If you need the App on your
organization and you are not the owning account, do not keep retrying the
URL — contact prpl support or your site administrator, who can arrange
installation or App ownership for your organization.
- On GitHub: you must be the App's owning account; for an organization target you also need to be an organization owner (or have a GitHub App manager approve the installation).
- In prpl: this guide is for organization administrators — the mapped owner of the GitHub namespace being protected.
Before you begin
- Know which repositories you want covered. You can start with Only select repositories and add more later.
- Installing the App does not by itself let prpl clone your code today — clone access is granted separately in Connect GitHub authentication. Do both.
- After you finish on GitHub, your browser returns to prpl's installation confirmation page, which shows the account and the repositories the App can see once GitHub's notification arrives (usually within seconds). The onboarding guide's install step also ticks itself once the installation is recorded.
Steps
- Open the installation page: github.com/apps/prpl-private/installations/new.
- Choose where to install: your personal account or one of your organizations.
GitHub's App installation page listing target accounts, calling out the organization account entry. - Under Repository access, choose All repositories or (recommended) Only select repositories, then pick the repositories prpl should cover.
The repository-access step of the GitHub install flow, calling out the "Only select repositories" option. - Review the permission list GitHub displays for the App, then select Install.
- Operators only: the App's own configuration (permissions, webhook, credentials) lives at github.com/settings/apps/prpl-private under the owning account.
Verify
- On GitHub, open the target account's Settings → Applications → Installed GitHub Apps (for an organization: Organization settings → GitHub Apps).
- Confirm
prpl-privateis listed, and select Configure to see exactly which repositories it covers.GitHub's Installed GitHub Apps list showing the prpl-private installation, calling out its "Configure" control.
Troubleshooting
- The install URL shows 404 Not Found. This is the private-App restriction, not an outage: only the account that owns
prpl-privatecan install it. Recovery: contact prpl support or your site administrator and tell them which account or organization needs the installation. - You can open the page but not choose your organization. You are not an owner of that organization on GitHub. Ask an organization owner to complete the installation, or to grant your installation request when GitHub prompts them.
- A repository you need is missing from the selection list. Repository selection only lists repositories in the account you chose. Switch the target account at the top of the install flow, or add the repository later via Configure on the installation.
- The App was suspended or uninstalled. See Manage the private GitHub App installation for suspension, uninstall, and recovery paths.
Next step
Connect GitHub authentication — the App installation and clone authorization are separate grants; prpl needs the second one to analyze code. Related: Manage the private GitHub App installation and Invite members with initial repository access.
Last verified against commit c0bf54d on 2026-07-10 · capture scenario: github-app-install