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
+24-20Lines changed: 24 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,16 @@ Search pages and blog posts from selected Confluence Cloud spaces. A Sim organiz
11
11
12
12
Search indexes each page's own text, including supported local callouts and code blocks. It does not expand Include Page, Excerpt Include, or third-party macros into that page. Referenced pages can be indexed separately with their own access rules.
13
13
14
-
Admin setup uses your organization's **Settings → Integrations** page. Teammates connect from **Integrations** in the main sidebar. For workspace Search, use **Search → Add source** instead; **Create & Invite** is the workspace equivalent of **Add source**.
14
+
Admin setup uses your organization's **Settings → Sources** page. Teammates connect from **Integrations** in the main sidebar. For workspace Search, use **Search → Add source** instead; **Create & Invite** is the workspace equivalent of **Add source**.
15
15
16
-
## Choose a connection method
16
+
## Choose a setup
17
17
18
18
| Method | Who supplies the content? | What teammates do |
19
19
| --- | --- | --- |
20
-
|**Admin or service account**| One account syncs content, space permissions, page restrictions, and group membership. | Connect their own Confluence account so Sim can match their Atlassian identity to those permissions. |
20
+
|**Central account**| One account syncs content, space permissions, page restrictions, and group membership. | Connect their own Confluence account so Sim can match their Atlassian identity to those permissions. |
21
21
|**Member accounts**| Sim syncs content separately through connected members' accounts. | Connect their own Confluence account to establish which pages they can access. |
22
22
23
-
Use **Admin or service account**when you have a dedicated account that can read the intended spaces and their permissions. Use **Member accounts**when each person should supply their own connection. Available methods depend on your organization's enabled features.
23
+
Adding a source from **Settings → Sources → Confluence → Sources**opens central account setup. Use this when one account can read the intended spaces and their permissions. For a member source, start **Connect account**from **Integrations** in the main sidebar after an admin adds Confluence. Available methods depend on your organization's enabled features.
24
24
25
25
**Everyone still connects in both methods.** With a central account, teammates supply their identity; they do not configure another central crawl or choose spaces again.
26
26
@@ -33,23 +33,21 @@ Use **Admin or service account** when you have a dedicated account that can read
33
33
34
34
On hosted Sim, personal connections authorize the existing Sim app. Teammates do not create OAuth apps or service-account tokens. Self-hosted deployments need the [shared OAuth configuration](#self-hosted-operator-setup) even when a service account supplies the content.
35
35
36
-
## Set up the source
36
+
## Set up a central source
37
37
38
38
<Steps>
39
39
<Step>
40
40
41
41
### Choose Confluence
42
42
43
-
Open **Settings → Integrations → Providers**, approve **Confluence**, then select **Set up**. Select your **Connection method**.
43
+
Open **Settings → Sources → Add integration** and choose **Confluence**. On its **Sources** tab, select **Add source**. If Confluence is already listed, open it directly. **Setup guide** opens this guide from the source form.
44
44
45
45
</Step>
46
46
<Step>
47
47
48
48
### Select an account
49
49
50
-
For **Admin or service account**, open **Account** and select an existing account, choose **Connect Confluence account** for OAuth, or add a service account using the [steps below](#using-a-service-account).
51
-
52
-
For **Member accounts**, **Browse with** supplies an account for the space picker only. Select or connect an account, or switch **Spaces** to manual input to enter space keys without a browsing account. Browsing does not connect that account to Search or share its access with teammates.
50
+
Under **Indexing account**, select an existing account, choose **Connect Confluence account** for OAuth, or add a service account using the [steps below](#using-a-service-account). The account must be able to read the content and its permissions.
53
51
54
52
</Step>
55
53
<Step>
@@ -58,27 +56,33 @@ For **Member accounts**, **Browse with** supplies an account for the space picke
58
56
59
57
Enter **Confluence Domain**, then choose one or more **Spaces**. The picker shows spaces accessible to the selected account. Use the switch beside the field to enter comma-separated **Space Keys**, such as `ENG, PRODUCT`.
60
58
61
-
Keep**Content Type** at its default for pages, or choose blog posts or both. Leave **Filter by Label** empty unless you want a smaller scope. **Document details (optional)** contains metadata tag settings.
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.
alt="Confluence central source setup with an indexing account, domain, and spaces"
64
+
width={520}
65
+
height={397}
68
66
/>
69
67
70
68
</Step>
71
69
<Step>
72
70
73
71
### Save and connect your identity
74
72
75
-
Click **Connect & Sync** for a central account, or **Add source**for member accounts. Back in Integrations, click **Connect account** on the Confluence row and finish the connection in the new tab. Sign in using the Atlassian email that matches your verified Sim email, and authorize the configured site.
73
+
Click **Connect & Sync**. Then open **Integrations**in the main sidebar, click **Connect account** on the Confluence source, and finish the connection in the new tab. Sign in using the Atlassian email that matches your verified Sim email, and authorize the configured site.
76
74
77
75
Each teammate completes this last step. A previously authorized account may already be connected. Return to Integrations to see indexing status and your searchable document count.
78
76
79
77
</Step>
80
78
</Steps>
81
79
80
+
## Connect member accounts
81
+
82
+
After an admin adds Confluence, open **Integrations** in the main sidebar and select **Connect account**. If there is no source yet, enter **Confluence Domain** and **Space Keys**, then select **Connect** and authorize your account. For another site or space scope, use **Add source** beside **Add another Confluence source**.
83
+
84
+
An admin can open the resulting source under **Settings → Sources → Confluence → Sources** and use **Settings** to adjust its filters. **Account for browsing** helps populate the space picker; it does not connect that account for Search. Manual space keys work without a browsing account.
85
+
82
86
## Using a service account
83
87
84
88
Sim's Atlassian service account form accepts a **scoped API token** and **site domain**.
@@ -135,12 +139,12 @@ read:group:confluence
135
139
136
140
### Add the token to Sim
137
141
138
-
In the Search setup's **Account** menu, choose the service-account option. Paste the **API token** and enter **Site domain**. Optionally add a display name and description, then click **Add service account**. Continue in the original source modal, using the same domain in both forms.
142
+
Under **Indexing account**, choose the service-account connection action. Paste the **API token** and enter **Site domain**. Optionally add a display name and description, then click **Add service account**. Continue in the original source modal, using the same domain in both forms.
139
143
140
144
</Step>
141
145
</Steps>
142
146
143
-
Scopes do not grant access to spaces or pages by themselves. Keep the account's Confluence permissions and its token scopes aligned. When a token expires or needs different scopes, create a replacement in Atlassian. In Sim, open **Integrations**, select the saved service account, and click **Reconnect** to enter the new token and the same site domain.
147
+
Scopes do not grant access to spaces or pages by themselves. Keep the account's Confluence permissions and its token scopes aligned. When a token expires or needs different scopes, create a replacement in Atlassian. Add the replacement service account in the source's **Settings**, then use **Change indexing account** to apply it.
144
148
145
149
<Callouttype="info">
146
150
Personal OAuth uses Sim's shared Confluence integration and requests a broader set of permissions, including writes. Search reads content and permissions; it does not edit your Confluence pages. Older OAuth connections need to reconnect to grant the group-read permission used by central permission syncing.
@@ -154,7 +158,7 @@ Personal OAuth uses Sim's shared Confluence integration and requests a broader s
154
158
|**Spaces / Space Keys**| Required spaces to index. The picker and manual key input are two ways to set the same scope. |
155
159
|**Content Type**|**Pages only** by default. **All content** means pages and blog posts; it does not include comments or attachment contents. |
156
160
|**Filter by Label**| Optional comma-separated labels. Content can match any listed label. |
157
-
|**Document details**| Optional labels, version, and last-modified metadata tags. |
161
+
|**Metadata tags**| Optional labels, version, and last-modified tags. In the add-source form, these are under **More options**. |
158
162
159
163
Search manages the schedule and hides item limits. Published/current content is indexed; archived and trashed content is excluded.
160
164
@@ -164,7 +168,7 @@ Existing organization members see the configured Confluence source and their own
164
168
165
169
With a central account, Sim applies space access together with the page's restrictions and inherited ancestor restrictions. Group membership is refreshed in the background. With member accounts, each person's provider listing determines the pages available to them. A Sim organization admin does not automatically receive access to every Confluence document.
166
170
167
-
New content and permission changes require a sync and processing before Search reflects them. Open **Manage** on the source to inspect errors, edit its configuration, or trigger a sync. If your own account needs authorization again, use **Reconnect**on the source row.
171
+
New content and permission changes require a sync and processing before Search reflects them. Open **Settings → Sources → Confluence → Sources → [source]** to inspect **Documents**, edit **Settings**, or review **Sync history**. If your own account needs authorization again, use **Reconnect**in the main Integrations page. Where available, the provider's **Accounts → Request connections** sends account connection requests; these do not invite people to the Sim organization.
168
172
169
173
## Troubleshooting
170
174
@@ -180,7 +184,7 @@ New content and permission changes require a sync and processing before Search r
180
184
181
185
### Check access in Confluence
182
186
183
-
Open a missing page in Confluence with the affected teammate's account. On the page, **Share → General access** shows whether access comes from the space, a parent, or an explicit restriction. A space admin can inspect restricted pages under **Space settings → Content → Restricted**. Check both the teammate and central crawling account when using **Admin or service account**. See Atlassian's [content access guide](https://support.atlassian.com/confluence-cloud/docs/add-or-remove-page-restrictions/).
187
+
Open a missing page in Confluence with the affected teammate's account. On the page, **Share → General access** shows whether access comes from the space, a parent, or an explicit restriction. A space admin can inspect restricted pages under **Space settings → Content → Restricted**. Check both the teammate and central crawling account when using a central source. See Atlassian's [content access guide](https://support.atlassian.com/confluence-cloud/docs/add-or-remove-page-restrictions/).
184
188
185
189
On Confluence Premium, **Inspect permissions** can show where a user's access is denied across the page, its ancestors, the space, and the product. Check **Can view**, resolve the relevant permission, then run a sync in Sim. See [Atlassian's permission inspection guide](https://support.atlassian.com/confluence-cloud/docs/inspect-a-users-permissions/).
186
190
@@ -192,6 +196,6 @@ Configure one shared Confluence OAuth integration for your deployment. This powe
192
196
2. Under **Authorization → OAuth 2.0 (3LO)**, add `https://<your-sim-domain>/api/auth/oauth2/callback/confluence` to **Callback URLs**, keep existing callbacks used by the deployment, and save.
193
197
3. Under **Permissions**, add the Confluence API and configure the full `confluence` scope list for your release in [Sim's OAuth configuration](https://github.com/simstudioai/sim/blob/staging/apps/sim/lib/oauth/oauth.ts), including `read:group:confluence`. Also add **User Identity API** with `read:me`. Sim requests `offline_access` for refresh tokens. The service-account read scopes above do not replace the broader shared OAuth scope set.
194
198
4. Enable sharing under **Distribution**. Set `CONFLUENCE_CLIENT_ID` and `CONFLUENCE_CLIENT_SECRET` from the app's **Settings**, verify `NEXT_PUBLIC_APP_URL`, and restart Sim.
195
-
5. Start authorization from Search and select the configured site. Reconnect old accounts after adding scopes so the new permission grant takes effect.
199
+
5. Start authorization from **Integrations** and select the configured site. Reconnect old accounts after adding scopes so the new permission grant takes effect.
196
200
197
201
A callback mismatch needs a corrected callback URL; a connection that works only for the app owner needs sharing enabled. See Atlassian's [OAuth configuration guide](https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/) and Sim's [deployment reference](/platform/self-hosting/integrations-oauth).
Your admin approves the provider and can configure shared source filters. You connect your own account so Sim can establish what you are allowed to search.
10
+
Your admin adds the integration and can configure shared source filters. You connect your own account so Sim can establish what you are allowed to search. Admins connect their own accounts through the same flow.
11
11
12
12
<Steps>
13
13
<Step>
@@ -21,11 +21,12 @@ Accept your Sim organization invitation or sign in through your organization's S
21
21
22
22
## Open Integrations
23
23
24
-
Open **Integrations**, find the provider or source, and select **Connect account**. Your first connection may ask for required source settings, such as repository or project names. If the provider is missing, ask an organization admin to approve it.
24
+
Open **Integrations** in the main sidebar, find the provider or source, and select **Connect account**. Your first connection may ask for a GitHub repository, Confluence domain and space keys, or Jira domain and project keys. Enter the required fields and select **Connect**. If the provider is missing, ask an organization admin to add it under **Settings → Sources**.
25
25
26
-
<Imagesrc="/static/search/connect-account.png"alt="Google Drive source row with Connect account"width={1280}height={720} />
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
+
28
+
<Imagesrc="/static/search/connect-account.png"alt="Organization Integrations showing approved providers and Connect account actions"width={738}height={680} />
27
29
28
-
*Workspace Search is shown here. Organization sources are managed in Settings → Integrations.*
29
30
30
31
</Step>
31
32
<Step>
@@ -34,7 +35,9 @@ Open **Integrations**, find the provider or source, and select **Connect account
34
35
35
36
In the new tab, select **Connect** and complete the provider's authorization. Choose the account associated with your verified Sim email. The provider may require your organization's SSO or app approval.
36
37
37
-
Return to Integrations when the connection completes. If the popup was blocked or closed, allow popups and select **Connect account** again. While authorization is pending, use **Open again**.
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
+
40
+
<Imagesrc="/static/search/member-enrollment.jpg"alt="Gmail account connection with Connect and Return to Search actions"width={680}height={305} />
38
41
39
42
</Step>
40
43
<Step>
@@ -59,6 +62,18 @@ For a source configured inside a workspace, join that workspace and use its **Se
59
62
60
63
Connecting one Google service does not connect all of them. Gmail, Calendar, and Drive each have their own Search connection.
61
64
65
+
## If you received a connection request
66
+
67
+
Open the link from your admin and sign in to Sim with the invited email. A provider-specific request opens that provider's connection directly. Verify your Sim email if prompted, then reopen the original link and authorize the account.
68
+
69
+
An account connection request does not invite you into the Sim organization. You can contribute an account without organization membership, but you need membership and enabled Search access to search the organization's documents. The connection page offers **Return to Search** when you have that access; otherwise it offers **Your connected accounts**.
70
+
71
+
## Manage your connected accounts
72
+
73
+
Select **Your accounts** on the main Integrations page to open your personal **Connected accounts** settings. Use **Reconnect** to renew an organization account connection or **Disconnect** to withdraw it. Disconnecting stops that account from being used for organization indexing and workflows, and removes Search access that depends on it.
74
+
75
+
Admins can select **Manage sources** to open organization setup, then open an integration's **Sources** and **Accounts** tabs. This does not grant the admin access to every document.
76
+
62
77
## If you get stuck
63
78
64
79
| Status | What to do |
@@ -67,7 +82,10 @@ Connecting one Google service does not connect all of them. Gmail, Calendar, and
67
82
|**Reconnect**| Authorize the same source account again. |
68
83
|**Finish connecting in the other tab**| Finish authorization, or use **Open again**. Allow popups for Sim. |
69
84
| No results | Check the source's filters and sync status with your admin. Confirm you can open the document at the source. |
70
-
| Needs admin attention | Ask your admin to inspect **Manage** for the source error. |
85
+
|**Verify email**| Verify your Sim email, then reopen the connection link. |
86
+
| Expired or cancelled authorization | Return to the original connection page and start again. If the invitation itself expired, ask the admin for a new request. |
87
+
| Access revoked | Ask the organization admin to restore your account contribution access before reconnecting. |
88
+
| Needs admin attention | Ask your admin to open **Settings → Sources → [integration] → Sources → [source]** to inspect its error. |
71
89
72
90
<Callouttype="info">
73
91
Your Sim role does not override document access at the source. Connecting a different account or receiving a Search link does not share someone else's mailbox, private calendar, or restricted documents with you.
0 commit comments