Skip to content

Commit 150ca26

Browse files
committed
improvement(docs): update GitHub App setup walkthrough
1 parent 60d8b71 commit 150ca26

4 files changed

Lines changed: 7 additions & 2 deletions

File tree

apps/docs/content/docs/platform/self-hosting/integrations-oauth.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,8 @@ The private key must include its PEM header, footer, and contents. Sim accepts a
199199

200200
Keep the private key and client secret in the deployment's server configuration; organization admins select installations in Sim without entering these secrets.
201201

202+
If you run Search indexing on Trigger.dev, configure the same five variables in its matching environment. The app server and indexing worker both need the App credentials; updating the app's secret store alone does not update a separately configured worker.
203+
202204
The **Client ID** is different from the numeric **App ID**. Use credentials from **Developer settings → GitHub Apps**. `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` belong to the separate GitHub sign-in integration and remain unchanged. Search does not read `GITHUB_REPO_CLIENT_ID` or `GITHUB_REPO_CLIENT_SECRET`.
203205

204206
Keep **Expire user authorization tokens** enabled so Sim receives the refresh token it needs to [renew personal connections](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens).

apps/docs/content/docs/search/github.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,17 @@ In **Sync documents with**, choose **Connect GitHub App** to index through an in
3838
<Image className="mx-auto h-auto w-full max-w-md" src="/static/search/github-indexing-options.jpg" alt="GitHub source setup with indexing choices for connected members, a GitHub account, or a GitHub App" width={402} height={240} />
3939

4040
1. Select **Connect your GitHub account** if prompted. Finish authorization in the new tab, then return and select **Refresh**.
41+
42+
<Image className="mx-auto h-auto w-full max-w-md" src="/static/search/github-installation-connect.jpg" alt="Connect GitHub App dialog requiring a personal GitHub connection to verify manageable installations" width={402} height={172} />
43+
4144
2. Select **Install GitHub App**. Choose your GitHub account or organization and the repositories to include. If it is already installed, check its repository selection.
4245
3. Return to Sim and select **Refresh**. Choose the installation and select **Use installation**. Only installations on your own account or organizations you own are available.
4346

44-
<Image className="mx-auto h-auto w-full max-w-md" src="/static/search/github-installation-connect.jpg" alt="Connect GitHub App dialog requiring a personal GitHub connection to verify manageable installations" width={402} height={210} />
47+
<Image className="mx-auto h-auto w-full max-w-md" src="/static/search/github-installation-select.jpg" alt="GitHub App installation chooser with Install GitHub App, Refresh, and Use installation controls; account name redacted" width={402} height={180} />
4548

4649
The installation is now selected under **Sync documents with**. You can reuse it when adding another repository source in the same Sim organization.
4750

48-
Alternatively, leave **Connected members** selected to use members' accounts for indexing, or select an existing dedicated account. Each method still requires teammates to connect their own accounts for Search access.
51+
Alternatively, leave **Connected members** selected to use members' accounts for indexing. To use a dedicated indexing account, select it under **Sync documents with**, or choose **Connect GitHub account** to add one. Each method still requires teammates to connect their own accounts for Search access.
4952

5053
</Step>
5154
<Step>
-4.74 KB
Loading
10.8 KB
Loading

0 commit comments

Comments
 (0)