Skip to content

Commit 5c298e4

Browse files
committed
improvement(docs): illustrate GitHub Search setup
1 parent 57c1c7c commit 5c298e4

5 files changed

Lines changed: 13 additions & 4 deletions

File tree

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,9 @@ 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.
199201

200202
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`.
201203

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

Lines changed: 10 additions & 3 deletions
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

@@ -25,7 +26,7 @@ To connect an installation for central indexing, you must be a Sim organization
2526

2627
### Open GitHub setup
2728

28-
Open **Settings → Sources** and turn on **GitHub** under **Allowed in Sim Search**. Select **Set up** (or **Manage** if sources already exist), then **Add source**.
29+
Open **Settings → Sources** and turn on **GitHub**. Select **Set up** (or **Manage** if sources already exist), then **Add source**.
2930

3031
</Step>
3132
<Step>
@@ -34,10 +35,14 @@ Open **Settings → Sources** and turn on **GitHub** under **Allowed in Sim Sear
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**.
3841
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.
3942
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.
4043

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

4348
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,6 +56,8 @@ Enter **Repository** as `owner/repo`. For installation indexing, it must belong
5156

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

59+
<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} />
60+
5461
| Field | What to enter |
5562
|---|---|
5663
| Repository | `owner/repo`. Add another source for another repository. |
@@ -65,13 +72,13 @@ Open **More options** if you need a different branch, path or extension filters,
6572

6673
### Connect your account
6774

68-
Open **Integrations** in the main sidebar, select **Connect account** on the GitHub source, and authorize the App. Teammates repeat this step after joining the Sim organization. For private repositories, both the person's account and the App installation must have access. GitHub also permits App user tokens to read public repositories without an installation; see [GitHub's permission rules](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app).
75+
Open **Integrations** in the main sidebar, select **Connect** beside the GitHub repository, and authorize the App. Teammates repeat this step after joining the Sim organization. For private repositories, both the person's account and the App installation must have access. GitHub also permits App user tokens to read public repositories without an installation; see [GitHub's permission rules](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app).
6976

7077
An App installation or dedicated indexing account can start syncing after the source is saved. With **Connected members**, indexing begins after someone connects. Each teammate still connects before searching. An existing GitHub connection in the same Sim organization is reused across its GitHub sources.
7178

7279
Open **Settings → Sources**, select **Manage** beside **GitHub**, then open the source to inspect **Documents**, edit **Settings**, or review **Sync history**.
7380

74-
Use **GitHub → Accounts → Request connections** to send provider-specific connection requests. These requests do not grant organization membership. For another repository, add another source; members can also use **Add another GitHub source** in the main Integrations page.
81+
Use **GitHub → Accounts → Request connections** to send provider-specific connection requests. These requests do not grant organization membership. For another repository, add another source; members can also select **Connect** on the GitHub row labeled **Connect a different site or content scope** in the main Integrations page.
7582

7683
</Step>
7784
</Steps>
17.5 KB
Loading
19.7 KB
Loading
9.96 KB
Loading

0 commit comments

Comments
 (0)