Skip to content

Commit b8ceb2e

Browse files
improvement(docs): illustrate GitHub Search setup (#7705)
* improvement(docs): illustrate GitHub Search setup * improvement(docs): update GitHub App setup walkthrough
1 parent 216b199 commit b8ceb2e

6 files changed

Lines changed: 16 additions & 2 deletions

File tree

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,11 @@ GITHUB_APP_CLIENT_SECRET=<Client secret>
195195
GITHUB_APP_PRIVATE_KEY=<complete RSA PEM private key>
196196
```
197197

198-
The private key must include its PEM header, footer, and contents. Sim accepts actual newlines or escaped `\n` sequences. Keep the private key and client secret in the deployment's server configuration; organization admins select installations in Sim without entering these secrets.
198+
The private key must include its PEM header, footer, and contents. Sim accepts actual newlines or escaped `\n` sequences. When storing it in a JSON secret, use the plaintext JSON editor and encode each line break as `\n` inside the string. Single-line key/value fields can remove line breaks; replacing them with spaces makes the PEM invalid. Restart Sim after saving configuration changes.
199+
200+
Keep the private key and client secret in the deployment's server configuration; organization admins select installations in Sim without entering these secrets.
201+
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.
199203

200204
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`.
201205

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ description: Index repository files with a GitHub App while preserving each pers
55

66
import { Callout } from 'fumadocs-ui/components/callout'
77
import { Step, Steps } from 'fumadocs-ui/components/steps'
8+
import { Image } from '@/components/ui/image'
89

910
GitHub Search indexes text files from repositories on `github.com`. An organization admin can install the GitHub App once and use it to index selected repositories. Each person connects their own GitHub account once to search the repositories they can access. Installing the App does not connect teammates or give them the installer's permissions.
1011

@@ -34,13 +35,20 @@ Open **Settings → Sources** and turn on **GitHub**. Select **Set up** (or **Ma
3435

3536
In **Sync documents with**, choose **Connect GitHub App** to index through an installation:
3637

38+
<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} />
39+
3740
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+
3844
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.
3945
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.
4046

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} />
48+
4149
The installation is now selected under **Sync documents with**. You can reuse it when adding another repository source in the same Sim organization.
4250

43-
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.
4452

4553
</Step>
4654
<Step>
@@ -51,6 +59,8 @@ Enter **Repository** as `owner/repo`. For installation indexing, it must belong
5159

5260
Open **More options** if you need a different branch, path or extension filters, or metadata tags.
5361

62+
<Image className="mx-auto h-auto w-full max-w-md" src="/static/search/github-setup.jpg" alt="GitHub repository configuration with branch, path filter, file extensions, and metadata tags" width={402} height={532} />
63+
5464
| Field | What to enter |
5565
|---|---|
5666
| Repository | `owner/repo`. Add another source for another repository. |
17.5 KB
Loading
15 KB
Loading
10.8 KB
Loading
9.96 KB
Loading

0 commit comments

Comments
 (0)