You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/search/confluence.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ Enter **Confluence Domain**, then choose one or more **Spaces**. The picker show
58
58
59
59
Open **More options** to change **Content Type**, **Filter by Label**, or **Metadata tags**. The default includes pages; choose **All content** for pages and blog posts. Leave the label filter empty unless you want a smaller scope.
60
60
61
-
<Image
61
+
<ImageclassName="mx-auto h-auto w-full max-w-md"
62
62
src="/static/search/confluence-setup.jpg"
63
63
alt="Confluence central source setup with an indexing account, domain, and spaces"
64
64
width={520}
@@ -101,7 +101,7 @@ Have an Atlassian organization admin create a service account under **Directory
101
101
102
102
Select the service account, then **Create credentials → API token → Next**. This is the credential type accepted by Sim's service-account form.
Copy file name to clipboardExpand all lines: apps/docs/content/docs/search/connect-your-account.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Open **Integrations** in the main sidebar, find the provider or source, and sele
25
25
26
26
Use **Add source** beside **Add another [provider] source** when you need another supported repository, site, or project scope. Connecting an existing source does not ask you to configure it again.
27
27
28
-
<Imagesrc="/static/search/connect-account.png"alt="Organization Integrations showing approved providers and Connect account actions"width={738}height={680} />
@@ -37,7 +37,7 @@ In the new tab, select **Connect** and complete the provider's authorization. Ch
37
37
38
38
Return to Integrations when the connection completes, or select **Return to Search** to open your organization’s Search page. Your account is saved when authorization completes; there is no separate submit step. If the popup was blocked or closed, allow popups and select **Connect account** again. While authorization is pending, use **Open again**.
39
39
40
-
<Imagesrc="/static/search/member-enrollment.jpg"alt="Gmail account connection with Connect and Return to Search actions"width={680}height={305} />
40
+
<ImageclassName="mx-auto h-auto w-full max-w-xl"src="/static/search/member-enrollment.jpg"alt="Gmail account connection with Connect and Return to Search actions"width={680}height={305} />
Authorization starts from Sim so the callback can finish the pending connection. The connector polls GitHub's API and does not need a webhook.
47
47
48
-
<Imagesrc="/static/search/github-app-callback.jpg"alt="GitHub App registration with the Redirect URI, expiring tokens enabled, and installation authorization, Device Flow, and webhooks disabled"width={768}height={929} />
48
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/github-app-callback.jpg"alt="GitHub App registration with the Redirect URI, expiring tokens enabled, and installation authorization, Device Flow, and webhooks disabled"width={768}height={929} />
49
49
50
50
*Example registration. Replace `sim.example.com` with your Sim domain.*
51
51
@@ -56,11 +56,11 @@ Authorization starts from Sim so the callback can finish the pending connection.
56
56
57
57
Expand **Permissions → Repository permissions**. Set **Contents → Access: Read-only**; leave the mandatory **Metadata** permission at **Read-only**.
58
58
59
-
<Imagesrc="/static/search/github-app-repository-permissions.jpg"alt="GitHub repository permissions with Contents set to Read-only and Metadata shown as mandatory Read-only"width={768}height={929} />
59
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/github-app-repository-permissions.jpg"alt="GitHub repository permissions with Contents set to Read-only and Metadata shown as mandatory Read-only"width={768}height={929} />
60
60
61
61
Expand **Account permissions** and set **Email addresses → Access: Read-only**.
62
62
63
-
<Imagesrc="/static/search/github-app-email-permission.jpg"alt="GitHub account permissions with only Email addresses selected for Read-only access"width={768}height={929} />
63
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/github-app-email-permission.jpg"alt="GitHub account permissions with only Email addresses selected for Read-only access"width={768}height={929} />
64
64
65
65
| Permission area | Permission | Access |
66
66
|---|---|---|
@@ -111,7 +111,7 @@ As a Sim organization admin, open **Settings → Sources → Add integration** a
111
111
112
112
Enter **Repository** as `owner/repo`. Open **More options** only if you need a different branch, path or extension filters, metadata tags, or a dedicated indexing account. **Sync documents with** defaults to **Connected members**.
113
113
114
-
<Imagesrc="/static/search/github-setup.jpg"alt="GitHub source setup with a required Repository field and More options"width={520}height={254} />
114
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/github-setup.jpg"alt="GitHub source setup with a required Repository field and More options"width={520}height={254} />
Copy file name to clipboardExpand all lines: apps/docs/content/docs/search/gitlab.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ import { Image } from '@/components/ui/image'
9
9
10
10
GitLab Search uses an administrator connection to sync a project's content and permissions. Teammates do not connect individual GitLab accounts. They sign in to the Sim organization with a verified email matching their confirmed GitLab email.
11
11
12
-
<Imagesrc="/static/search/gitlab-setup.jpg"alt="GitLab source setup in Sim Search"width={520}height={479} />
12
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/gitlab-setup.jpg"alt="GitLab source setup in Sim Search"width={520}height={479} />
13
13
14
14
Admin setup uses your organization's **Settings → Sources** page. Teammates do not need a personal GitLab connection. For workspace Search, use **Search → Add source** instead.
15
15
@@ -30,7 +30,7 @@ Use a self-managed GitLab instance running version **17.4 or later**. Setup need
30
30
31
31
Sign in to your self-managed GitLab instance as an instance administrator, then open **Avatar → Edit profile → Access → Personal access tokens**. On current releases choose **Generate token → Legacy token**; older versions show **Add new token** or the token form directly.
32
32
33
-
<Imagesrc="https://handbook.gitlab.com/images/security/product-security/security-platforms-and-architecture/service-account-access-token-page.png"alt="Official GitLab example of the Access Tokens page with the Add new token button"width={1759}height={586} />
33
+
<ImageclassName="mx-auto h-auto w-full max-w-xl"src="https://handbook.gitlab.com/images/security/product-security/security-platforms-and-architecture/service-account-access-token-page.png"alt="Official GitLab example of the Access Tokens page with the Add new token button"width={1759}height={586} />
34
34
35
35
*Official [GitLab Handbook example](https://handbook.gitlab.com/handbook/security/product-security/security-platforms-architecture/product-security-engineering/runbooks/rotate-service-account-personal-access-tokens/). Navigation and button labels vary by version. The example's existing `api` tokens are unrelated to Sim; use the scopes below.*
36
36
@@ -63,7 +63,7 @@ Open **Settings → Sources → Add integration** and choose **GitLab**. On its
63
63
64
64
**More options** contains the repository and issue filters, **Max Items**, and **Metadata tags**. Unlike member-account sources, GitLab retains this optional item limit.
65
65
66
-
<Imagesrc="/static/search/gitlab-options.jpg"alt="GitLab source setup with More options expanded for repository and issue filters, item limit, and metadata tags"width={520}height={625} />
66
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/gitlab-options.jpg"alt="GitLab source setup with More options expanded for repository and issue filters, item limit, and metadata tags"width={520}height={625} />
67
67
68
68
Select **Connect & Sync**. Sim validates the token and source policy, then starts indexing.
<Imagesrc="/static/search/google-oauth-web-client.png"alt="Google Cloud Web application client form with Sim's Gmail, Calendar, and Drive callback URLs"width={768}height={929} />
96
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/google-oauth-web-client.png"alt="Google Cloud Web application client form with Sim's Gmail, Calendar, and Drive callback URLs"width={768}height={929} />
97
97
98
98
This Google Cloud example uses one client for all three services. Replace `https://sim.example.com` with your Sim origin and add only the callbacks for services you enable.
`primary` means the connected person's main calendar. A calendar selected from the list is a specific calendar ID, even when it is your main calendar. That same ID applies to every member, and only members with access to it can search its events.
@@ -100,7 +100,7 @@ The deployment operator configures Google OAuth once; teammates then use the nor
<Imagesrc="/static/search/google-oauth-web-client.png"alt="Google Cloud Web application client form with Sim's Gmail, Calendar, and Drive callback URLs"width={768}height={929} />
103
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/google-oauth-web-client.png"alt="Google Cloud Web application client form with Sim's Gmail, Calendar, and Drive callback URLs"width={768}height={929} />
104
104
105
105
This Google Cloud example uses one client for all three services. Replace `https://sim.example.com` with your Sim origin and add only the callbacks for services you enable.
Copy file name to clipboardExpand all lines: apps/docs/content/docs/search/google-drive.mdx
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ Open **Settings → Sources → Google Drive → Sources → Add source**. This
56
56
57
57
This requires a Google Workspace domain and a Workspace super administrator to authorize domain-wide delegation. Consumer Gmail accounts cannot use this path.
58
58
59
-
<Imagesrc="/static/search/google-drive-setup.jpg"alt="Google Drive central source setup with an indexing account, sharing policy, and folder scope"width={520}height={404} />
59
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/google-drive-setup.jpg"alt="Google Drive central source setup with an indexing account, sharing policy, and folder scope"width={520}height={404} />
60
60
61
61
<Steps>
62
62
<Step>
@@ -65,11 +65,11 @@ This requires a Google Workspace domain and a Workspace super administrator to a
65
65
66
66
In [Google Cloud Console](https://console.cloud.google.com/), select your project and enable **Google Drive API** and **Admin SDK API** under **APIs & Services → Library**. Then open **IAM & Admin → Service Accounts → Create service account**, enter a name, and finish creation. Google Cloud project roles do not grant access to Workspace files; they are not required for this crawl.
67
67
68
-
<Imagesrc="/static/search/google-create-service-account.png"alt="Google Cloud Console form for creating a service account"width={1024}height={735} />
68
+
<ImageclassName="mx-auto h-auto w-full max-w-xl"src="/static/search/google-create-service-account.png"alt="Google Cloud Console form for creating a service account"width={1024}height={735} />
69
69
70
70
Open the service account's **Keys** tab and choose **Add key → Create new key → JSON**, then select **Create** to download the key. Store it securely; you will add it to Sim next. See [Google's key creation guide](https://docs.cloud.google.com/iam/docs/keys-create-delete#creating).
71
71
72
-
<Imagesrc="/static/search/google-create-private-key.png"alt="Google Cloud Create private key dialog with JSON selected"width={1024}height={502} />
@@ -78,7 +78,7 @@ Open the service account's **Keys** tab and choose **Add key → Create new key
78
78
79
79
In the service account's **Details**, expand **Advanced settings** and copy its numeric **Client ID**. Sign in to the [Workspace Admin Console](https://admin.google.com/ac/owl/domainwidedelegation) as a super administrator. Open **Security → Access and data control → API controls → Manage Domain Wide Delegation → Add new**.
80
80
81
-
<Imagesrc="/static/search/google-domain-delegation.png"alt="Google Workspace Admin Console Add a new client ID dialog with Client ID and OAuth scopes fields"width={768}height={929} />
81
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/google-domain-delegation.png"alt="Google Workspace Admin Console Add a new client ID dialog with Client ID and OAuth scopes fields"width={768}height={929} />
82
82
83
83
Paste that Client ID into **Client ID**, then enter these exact scopes as a comma-separated list under **OAuth scopes**:
84
84
@@ -97,7 +97,7 @@ These are Search's central crawl scopes. The general [Google service account gui
97
97
98
98
Under **Indexing account**, choose the service-account connection action, or select an existing service account. Paste the JSON key into **Add Google Service Account**, give it a name, and add it. Sim returns you to the source form with that credential selected.
99
99
100
-
<Imagesrc="/static/search/google-service-account.jpg"alt="Add Google Service Account credential modal in Sim"width={520}height={562} />
100
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/google-service-account.jpg"alt="Add Google Service Account credential modal in Sim"width={520}height={562} />
101
101
102
102
</Step>
103
103
<Step>
@@ -146,7 +146,7 @@ The deployment operator configures Google OAuth for member accounts and **Accoun
<Imagesrc="/static/search/google-oauth-web-client.png"alt="Google Cloud Web application client form with Sim's Gmail, Calendar, and Drive callback URLs"width={768}height={929} />
149
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/google-oauth-web-client.png"alt="Google Cloud Web application client form with Sim's Gmail, Calendar, and Drive callback URLs"width={768}height={929} />
150
150
151
151
This Google Cloud example uses one client for all three services. Replace `https://sim.example.com` with your Sim origin and add only the callbacks for services you enable.
Copy file name to clipboardExpand all lines: apps/docs/content/docs/search/index.mdx
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ Open **Integrations** in the main sidebar and select **Connect account** if prom
39
39
</Step>
40
40
</Steps>
41
41
42
-
<Imagesrc="/static/search/add-source.jpg"alt="Organization Sources settings with the Add integration action"width={738}height={720} />
42
+
<ImageclassName="mx-auto h-auto w-full max-w-xl"src="/static/search/add-source.jpg"alt="Organization Sources settings with the Add integration action"width={738}height={720} />
43
43
44
44
Source availability depends on the deployment and organization policy. An unavailable source needs operator configuration before setup can continue.
45
45
@@ -84,13 +84,13 @@ These requests are separate from organization invitations. They let recipients c
84
84
85
85
**Revoke all account access** withdraws every account that person contributed to the organization, including other providers. It does not remove their organization membership.
86
86
87
-
<Imagesrc="/static/search/request-connections.jpg"alt="Request Gmail connections with an Emails field and Send requests action"width={520}height={290} />
87
+
<ImageclassName="mx-auto h-auto w-full max-w-md"src="/static/search/request-connections.jpg"alt="Request Gmail connections with an Emails field and Send requests action"width={520}height={290} />
88
88
89
89
## Manage sources and documents
90
90
91
91
Open **Settings → Sources → [integration]**, then select a source. Providers with personal connections have **Sources** and **Accounts** tabs; providers such as GitLab open directly to the source list. Multiple sources can have different folder, repository, space, or project scopes.
92
92
93
-
<Imagesrc="/static/search/integration-provider.jpg"alt="Integration detail with Sources and Accounts tabs and a nested source list"width={738}height={390} />
93
+
<ImageclassName="mx-auto h-auto w-full max-w-xl"src="/static/search/integration-provider.jpg"alt="Integration detail with Sources and Accounts tabs and a nested source list"width={738}height={390} />
94
94
95
95
| Source tab | What you can do |
96
96
| --- | --- |
@@ -100,9 +100,9 @@ Open **Settings → Sources → [integration]**, then select a source. Providers
100
100
101
101
Use the source header to sync, pause, resume, or remove that source. The back link returns to its integration. **Deactivate** on the integration page makes its content unavailable in Search, Assistant, and MCP while preserving its sources and connected accounts; **Activate** enables it again.
102
102
103
-
<Imagesrc="/static/search/source-settings.jpg"alt="Gmail source Settings tab with label, date range, and search filters"width={1022}height={680} />
103
+
<ImageclassName="mx-auto h-auto w-full max-w-xl"src="/static/search/source-settings.jpg"alt="Gmail source Settings tab with label, date range, and search filters"width={1022}height={680} />
104
104
105
-
<Imagesrc="/static/search/source-sync-history.jpg"alt="Source Sync history with no connected accounts or synced members"width={1022}height={430} />
105
+
<ImageclassName="mx-auto h-auto w-full max-w-xl"src="/static/search/source-sync-history.jpg"alt="Source Sync history with no connected accounts or synced members"width={1022}height={430} />
106
106
107
107
## Search, Assistant, and MCP
108
108
@@ -141,7 +141,7 @@ A completed sync means the source was checked; some documents may still be index
141
141
142
142
As an admin, open **Settings → Sources → [integration] → Sources → [source]**. In **Documents**, select **Failed** from the status dropdown to inspect those files. Use the search field to find a document by name. Select **Retry indexing** beside a file to try again. **Exclude** removes a file from search; select **Excluded** and then **Restore** to include it again. Fix a disconnected account or source configuration before retrying a sync that needs attention.
143
143
144
-
<Imagesrc="/static/search/source-documents.jpg"alt="Empty source Documents tab with search and an Included status filter"width={1022}height={430} />
144
+
<ImageclassName="mx-auto h-auto w-full max-w-xl"src="/static/search/source-documents.jpg"alt="Empty source Documents tab with search and an Included status filter"width={1022}height={430} />
145
145
146
146
Temporary indexing-capacity waits retry automatically in the background. If automatic retries are exhausted, the document appears as failed so an admin can retry it. Other searchable documents remain available while this work finishes.
0 commit comments