From 80e81ceab392f7fdb8205e02cda5a14d63de37d5 Mon Sep 17 00:00:00 2001 From: Carolina Roncaglia Date: Mon, 31 Aug 2026 13:47:28 -0300 Subject: [PATCH] docs: document accepted private key formats for GitHub App auth The GitHub App walkthrough ended at "Carefully save the private key file" and never told the reader which key formats the connector accepts, or that the contents of that file can be supplied instead of a path. loadPrivateKeyFromString accepts PKCS#1 and PKCS#8, so a key from GitHub's Generate a private key button and one produced by OpenSSL 3.0+ both work with no conversion. Co-Authored-By: Claude Opus 5 --- docs/connector.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/connector.mdx b/docs/connector.mdx index d1179a1a..12e96d0a 100644 --- a/docs/connector.mdx +++ b/docs/connector.mdx @@ -214,6 +214,13 @@ Scroll down to the **Private keys** section of the app's page and click **Genera 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. Finally, install the new app on your GitHub organization. Navigate to **Developer Settings** > **GitHub Apps**.