Skip to content

Commit d671a17

Browse files
authored
Merge branch 'main' into add-security-and-data-processing
2 parents 3209dcb + 610e6d2 commit d671a17

25 files changed

Lines changed: 220 additions & 4 deletions

cspell.config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ words:
4646
- Langchain
4747
- bitnami
4848
- litellm
49+
- reportportal
4950
- berriai
5051
- Ollama
5152
# Cloud/Infrastructure

docs/admin/deployment/common/deployment/05-components-deployment/manual-deployment/plugin-engine/_plugin-engine-content.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ nats://<domain>:<port>
310310
```
311311

312312
</TabItem>
313-
<TabItem value="nats-tls" label="Termination on Ingress">
313+
<TabItem value="nats-tls" label="Termination on NATS Instance">
314314

315315
### NATS-Managed TLS
316316

docs/user-guide/getting-started/glossary.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,8 @@ An industry-standard protocol for integrating external tools with AI assistants.
153153

154154
A workspace within the CodeMie platform that delineates and isolates working environments, ensuring that users' activities do not interfere with one another. Projects are typically created by team leaders or administrators and facilitate structured project management. All data sources, integrations, and assistants are associated with a specific project.
155155

156+
**Important**: Project names must be in lowercase only. Uppercase characters are not allowed in project names.
157+
156158
### Project Admin
157159

158160
A user with administrative privileges within the CodeMie platform. Project Admins have extended functionality including the ability configure Project Integrations (available to all team members), view all project assistants and workflows and manage project-level settings. Only Admin roles or user with attribute applications_admin have access to these administrative functions.
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
id: confluence
3+
title: Confluence
4+
sidebar_label: Confluence
5+
pagination_prev: user-guide/tools_integrations/tools/overview
6+
pagination_next: null
7+
sidebar_position: 16
8+
---
9+
10+
import Tabs from '@theme/Tabs';
11+
import TabItem from '@theme/TabItem';
12+
13+
# Confluence
14+
15+
CodeMie integrates with Atlassian Confluence to allow assistants to retrieve and interact with your Confluence spaces, pages, and articles. This enables AI-powered search and summarization of your team's knowledge base directly from the chat.
16+
17+
## 1. Create API Token
18+
19+
<Tabs groupId="confluence-version">
20+
<TabItem value="cloud" label="Confluence Cloud" default>
21+
22+
1.1. Click your profile icon in the top-right corner and select **Account settings**:
23+
24+
![Confluence Cloud — Account settings](./images/confluence-cloud-account-settings.png)
25+
26+
1.2. Navigate to the **Security** tab. In the **API Tokens** section, click **Create API token**:
27+
28+
![Atlassian Account — API Tokens page](./images/confluence-api-tokens.png)
29+
30+
1.3. Specify a token name (e.g., "codemie-demo"), set an expiration date, and click **Create**:
31+
32+
![Create an API token dialog](./images/confluence-create-token.png)
33+
34+
1.4. Click **Copy** to copy the generated API token and store it securely:
35+
36+
:::warning
37+
You can't recover the API token after you close this dialog. Make sure to copy and save it before clicking **Done**.
38+
:::
39+
40+
![Copy your API token dialog](./images/confluence-copy-token.png)
41+
42+
</TabItem>
43+
<TabItem value="self-hosted" label="Confluence Self-hosted">
44+
45+
1.1. Log in to your Confluence instance. Click your profile icon in the top-right corner and select **API Token Authentication**:
46+
47+
![Confluence Self-hosted — API Token Authentication menu](./images/confluence-selfhosted-menu.png)
48+
49+
1.2. On the **My API Tokens** page, click **New API Token**:
50+
51+
![My API Tokens page](./images/confluence-selfhosted-api-tokens.png)
52+
53+
1.3. Fill in the token details and click **Create API Token**:
54+
55+
- **API Token Description**: Enter a descriptive name for your token (e.g., "API Token from 2026-02-11").
56+
- **API Token Expiration**: Select expiration period (e.g., "6 months").
57+
- **Token Scope**: Choose **Read & Write** for full access.
58+
59+
![New API Token form](./images/confluence-selfhosted-new-token.png)
60+
61+
1.4. Copy the generated token and store it securely:
62+
63+
:::warning
64+
You won't be able to see your token once you leave this screen. Make sure to copy and save it.
65+
:::
66+
67+
![Copy API Token](./images/confluence-selfhosted-copy-token.png)
68+
69+
</TabItem>
70+
</Tabs>
71+
72+
## 2. Configure Integration in CodeMie
73+
74+
2.1. In the CodeMie main menu, click **Integrations**, select **User** or **Project** tab, and click **+ Create**.
75+
76+
2.2. Specify the integration parameters and click **+ Save**:
77+
78+
- **Project**: Select your CodeMie project name.
79+
- **Global Integration**: Toggle on to use across multiple projects. If disabled, the integration will only be available within the selected project, and assistants and workflows attached to other projects will not be able to use it.
80+
- **Credential Type**: Confluence
81+
- **Alias**: Enter integration name (e.g., "codemie-demo").
82+
- **URL**: Your Confluence instance URL:
83+
- For Confluence Cloud: `https://your-domain.atlassian.net`
84+
- For Confluence Self-hosted: your own Confluence server URL (e.g., `https://confluence.example.com`)
85+
- **Is Confluence Cloud**:
86+
-**Check this box** if you're using **Confluence Cloud**
87+
-**Leave unchecked** if you're using **Confluence Self-hosted**
88+
- **Username/email for Confluence**: Your Atlassian account email (e.g., `user@example.com`).
89+
- **Token/ApiKey**: Paste the API token copied in step 1.4.
90+
91+
![CodeMie Confluence integration form](./images/confluence-codemie-integration.png)
92+
93+
:::tip
94+
You can click the **Test** button to verify the connection before saving. You should see an "Integration test successful" notification if the parameters are correct.
95+
:::
96+
97+
:::info
98+
If you create this integration under the **Project** tab, the key will be available to the entire project by default, meaning all project members can use it.
99+
:::
100+
101+
## 3. Create Assistant with Confluence Tool
102+
103+
3.1. Click **Explore Assistant**, then click **Create Assistant** or edit an existing one.
104+
105+
3.2. In the assistant settings, expand the **Project Management** section under available tools, check **Generic Confluence**, and select your Confluence integration alias from the dropdown:
106+
107+
![Assistant setup with Confluence tool](./images/confluence-assistant-setup.png)
108+
109+
3.3. Click **Create** or **Save** to finalize your assistant.
110+
111+
## 4. Use Your Assistant
112+
113+
4.1. Select your assistant and start a conversation. You can interact with your Confluence data using natural language, for example:
114+
115+
- "Get me some article from Confluence"
116+
- "Find all pages in the codemie-demo space"
117+
- "Summarize the Getting Started page from Confluence"
118+
119+
The assistant will retrieve articles from your Confluence spaces and present them with space names and direct links:
120+
121+
![Confluence chat example](./images/confluence-chat-example.png)
231 KB
Loading
406 KB
Loading
499 KB
Loading
451 KB
Loading
431 KB
Loading
263 KB
Loading

0 commit comments

Comments
 (0)