diff --git a/docs/custom-github-app.md b/docs/custom-github-app.md index 1a78960b..be20a386 100644 --- a/docs/custom-github-app.md +++ b/docs/custom-github-app.md @@ -7,7 +7,7 @@ description: Install gitStream on Your GitHub Server. This guide is for installations on self-hosted GitHub Server. If you are using the gitStream cloud service, please refer to [this guide](github-installation.md). -# Create GitHub App +# Custom GitHub App for Self-Hosted GitHub Server A GitHub application serves as the link between gitStream and GitHub. It facilitates user authentication via OAuth2 and allows users to select repositories accessible by gitStream. @@ -20,20 +20,21 @@ In this section, we'll guide you through creating a GitHub app for your self-hos Throughout this document, when we refer to a GitHub account, it refers to your own GitHub Server installation. -## 1. Prerequisites +## 1. Connect GitHub Server to LinearB -1. Self-hosted GitHub Server -3. Login, or create a free account on the LinearB app, and follow the steps to connect gitStream Using a GitLab Integration. +First login, or create a free account on the LinearB app. -In LinearB, go to Settings -> Git -> click the Connect gitStream button next to your GitHub Server integration. You’ll need to use the `Webhook URL` and `Webhook secret` later when setting up the GitHub App. +In LinearB, go to Settings -> Git -> click the `Connect gitStream` button next to your GitHub Server integration. You’ll need to use the **Webhook URL** and **Webhook secret** later when setting up the GitHub App. ![LinearB setup](screenshots/setup-linearb-github-server-step-1.png) +Keep this window open and complete the next steps in GitHub. Once you have the **App ID** and **Private Key** (.pem file), you can complete the connection in LinearB. + ## 2. Create a New GitHub App Any GitHub account can own the app, but we recommend creating it under the organization account of the team who will maintain the gitStream installation. -- Log in to GitHub and go to your organization account page (e.g., `https://github.com/`). +- Log in to [GitHub](https://github.com/) and go to your organization account page (e.g., `https://github.com/`). - Click on *Settings -> Developer Settings -> GitHub Apps -> New GitHub App* as shown below. - Or go directly to `https://github.com/organizations//settings/apps/new`