Skip to content

docs: document accepted private key formats for GitHub App auth #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
luisina-santos merged 1 commit into from
Aug 31, 2026
Merged

docs: document accepted private key formats for GitHub App auth #186

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/connector.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,13 @@ Scroll down to the **Private keys** section of the app's page and click **Genera
</Step>
<Step>
Carefully save the private key file.

The connector accepts a PEM-encoded **RSA** private key in either format, so no conversion is needed:

- **PKCS#1** — header line `-----BEGIN RSA PRIVATE KEY-----`, which is what **Generate a private key** produces
- **PKCS#8** — header line `-----BEGIN PRIVATE KEY-----`, which is what OpenSSL 3.0+ produces by default

When you configure the connector, you can supply either the key file itself or the PEM contents of that file.
</Step>
<Step>
Finally, install the new app on your GitHub organization. Navigate to **Developer Settings** > **GitHub Apps**.
Expand Down
Loading