diff --git a/enterprise/quick-start.mdx b/enterprise/quick-start.mdx index b554560d..7c0f33e6 100644 --- a/enterprise/quick-start.mdx +++ b/enterprise/quick-start.mdx @@ -337,80 +337,11 @@ configure a GitHub App. #### Create a GitHub App -1. Go to [github.com/settings/apps](https://github.com/settings/apps) and click **New GitHub App**. - -2. Set a unique **GitHub App name** (e.g., `ACME Corp OpenHands`). - -3. Set the **Homepage URL** to `https://app.`. - -4. Under **Identifying and authorizing users**: - - Set the **Callback URL** to: - ``` - https://auth.app./realms/allhands/broker/github/endpoint - ``` - - Check the box for **Request user authorization (OAuth) during installation** - -5. Under **Webhook**: - - Set the **Webhook URL** to: - ``` - https://app./integration/github/events - ``` - - Generate a webhook secret: - ```bash - export WEBHOOK_SECRET=$(openssl rand -base64 32 | tr -dc A-Za-z0-9 | head -c 32) - echo $WEBHOOK_SECRET - ``` - - Paste the generated value into the **Secret** field - - - Save the webhook secret value -- you will need to enter it in the Admin Console configuration. - - -6. Under **Permissions**, configure the following: - - **Repository permissions:** - - | Permission | Access | - |-----------|--------| - | Actions | Read and write | - | Commit statuses | Read and write | - | Contents | Read and write | - | Issues | Read and write | - | Pull requests | Read and write | - | Webhooks | Read and write | - | Workflows | Read and write | - - **Organization permissions:** - - | Permission | Access | - |-----------|--------| - | Events | Read-only | - - **Account permissions:** - - | Permission | Access | - |-----------|--------| - | Email addresses | Read-only | - -7. Click **Create GitHub App**. - -8. On the GitHub App page, under **Client secrets**, click **Generate a new client secret**. - Save this value. - -9. Under **Private keys**, click **Generate a private key**. The `.pem` file downloads - automatically -- note its location. +Run our [script](https://github.com/All-Hands-AI/OpenHands-Cloud/tree/main/scripts/create_github_app) to create a GitHub App configured for your install. #### Map GitHub App values to Admin Console -Go back to the Installer Admin Console in your browser and enter the following values: - -| GitHub App Value | Admin Console Field | -|-----------------|-------------------| -| Client ID (shown on app page) | GitHub OAuth Client ID | -| Client secret (from step 8) | GitHub OAuth Client Secret | -| App ID (shown on app page) | GitHub App ID | -| Webhook secret (from step 5) | GitHub App Webhook Secret | -| Private key file (from step 9) | GitHub App Private Key (file upload) | +Go back to the Installer Admin Console in your browser and enter the values from the Create GitHub App script output. For the private key, upload the file from the `keys` directory of the script location. After filling in all fields, click **Continue** at the bottom of the page.