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: docs/introduction.md
+37-30Lines changed: 37 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,55 +5,62 @@ sidebar_position: 1
5
5
6
6
# Introduction
7
7
8
-
Welcome to **Docmost**, an open-sourcecollaborative wiki and documentation software.
8
+
Welcome to **Docmost**, an open-source, enterprise-ready collaborative wiki and documentation software.
9
9
Designed for seamless real-time collaboration, multiple users can work on the same page at the same time in real-time without overwriting each other.
10
10
11
11
Docmost is an open-source alternative to the likes of Notion and Confluence. Whether you're managing a wiki, a knowledge base, or extensive project documentation, Docmost provides the tools you need to create, collaborate, and share knowledge effortlessly.
12
12
13
-
Docmost has support for Spaces. You can create Spaces for different teams, projects, or departments depending on your needs. Each Space comes with its own permissions.
14
-
15
-
The rich text editor has support for markdown shortcuts.
13
+
Docmost has support for Spaces. You can create Spaces for different teams, projects, or departments depending on your needs. Each Space comes with its own permissions. With an optional enterprise edition, Docmost scales to meet the needs of larger organizations with SSO, AI, API access, and more.
16
14
17
15
18
16
19
17
## Features
20
18
21
19
-**Collaborative Real-time Editor**: Work together on pages in real-time.
22
-
-**Diagrams**: Built-in support for Draw.io, Excalidraw and Mermaid diagramming tools.
23
20
-**Spaces**: Organize your pages by team, projects, or departments for better collaboration.
24
-
-**AI Search (ASK AI)**: Ask questions and get answers directly from your page content.
25
-
-**Public sharing**: You can publicly share your pages, allowing anyone with the link to view them.
26
-
-**Permissions Management**: Easily control access to contents with easy to understand permissions.
27
-
-**Groups**: Easily grant unified permissions to users via groups.
21
+
-**Permissions Management**: Easily control access to content with intuitive permissions at the workspace and space level.
22
+
-**Groups**: Grant unified permissions to users via groups.
23
+
-**Nested Navigation**: Nest, reorder, and drag-and-drop pages via the sidebar.
24
+
-**Tables**: Insert and edit tables with resizable columns, mergeable cells, header rows/columns, and cell background colors.
25
+
-**Diagrams**: Built-in support for Draw.io, Excalidraw, and Mermaid diagramming tools.
26
+
-**Math Equations**: Write inline and block-level math equations using KaTeX.
27
+
-**Callouts and Toggle Blocks**: Structure your content with callout notices and collapsible toggle blocks.
28
28
-**Comments**: Add comments to pages for better communication and feedback.
29
-
-**Page History**: Track changes with a comprehensive version history.
30
-
-**Nested Navigation**: You can nest and reorder pages via the sidebar.
31
-
-**Search**: Quickly find the information you need with powerful search capabilities.
29
+
-**Page History**: Track changes with a comprehensive version history and restore previous versions.
30
+
-**Public Sharing**: Publicly share your pages, allowing anyone with the link to view them.
31
+
-**Search**: Full-text search across pages with space and type filters.
32
32
-**File Attachment**: Attach files to your pages for easy reference and sharing.
33
-
-**Search in attachments:** Search for content in PDF and DOCX file attachments (Enterprise Edition)
34
-
-**Import / Export**: You can easily import and export pages in Markdown and HTML formats.
35
-
- Zip import
33
+
-**Import / Export**: Import and export pages in Markdown and HTML formats.
34
+
- ZIP archive import
36
35
- Notion import
37
-
- Confluence import (Enterprise Edition)
38
-
-**Read/Edit preference mode:** Say goodbye to accidental edits.
39
-
-**Translations**: Docmost is available in over 10+ languages. 🇺🇸 🇨🇳 🇫🇷 🇩🇪 🇮🇹 🇯🇵 🇰🇷 🇧🇷 🇷🇺 🇪🇸🇺🇦
36
+
- Confluence import (Enterprise)
37
+
- DOCX import (Enterprise)
38
+
-**Print to PDF**: Generate PDF versions of pages using the browser print dialog.
39
+
-**@ Mentions**: Mention team members and link to pages directly in the editor.
40
+
-**Markdown Shortcuts**: Type Markdown syntax directly in the editor and it converts to rich text automatically.
41
+
-**Keyboard Shortcuts**: Full set of keyboard shortcuts for formatting, navigation, and editor actions.
42
+
-**Dark Mode**: Switch between light, dark, and system themes.
43
+
-**Read/Edit Mode**: Set a default page mode to prevent accidental edits.
44
+
-**Translations**: Available in 12+ languages. 🇺🇸 🇨🇳 🇫🇷 🇩🇪 🇮🇹 🇯🇵 🇰🇷 🇧🇷 🇷🇺 🇪🇸 🇳🇱 🇺🇦
40
45
41
46
## Authentication
42
47
- Email and password
43
-
- LDAP (enterprise edition)
44
-
- SSO (SAML/OIDC) is available in our enterprise edition [<ahref="mailto:sales@docmost.com?subject=Docmost Enterprise License">Purchase enterprise license</a>].
48
+
- LDAP (Enterprise)
49
+
- SSO via SAML / OIDC (Enterprise)
50
+
- MFA via TOTP (Enterprise)
45
51
46
52
## Enterprise Edition Features
47
-
- SSO (SAML 2.0 / OIDC ) - Integrate Microsoft Entra ID, Okta, OneLogin and more.,
48
-
- LDAP
49
-
- MFA (TOTP)
50
-
- AI Search (ASK AI)
51
-
- API keys management
52
-
- Full-text search in attachments (PDF, DOCX)
53
-
- Resolve comments
54
-
- Confluence importer
55
-
- Email support
56
-
- Audit logs (coming soon)
53
+
-**SSO** (SAML 2.0 / OIDC) — Integrate Microsoft Entra ID, Okta, OneLogin, and more.
54
+
-**LDAP** — Authenticate users against your LDAP directory.
55
+
-**MFA** (TOTP) — Multi-factor authentication with authenticator apps.
56
+
-**AI** — AI-powered writing assistance (Ask AI) and AI-powered search (AI Answers). Use cloud models or local LLMs.
57
+
-**API** — REST API with personal API keys and admin key management.
58
+
-**Full-text search in attachments** — Search content inside PDF and DOCX file attachments.
59
+
-**Resolve comments** — Mark comment threads as resolved.
60
+
-**Disable public sharing** — Control public sharing at the workspace or space level.
61
+
-**Confluence importer** — Import Confluence spaces with preserved formatting, hierarchy, and attachments.
62
+
-**DOCX importer** — Import Microsoft Word documents.
By default, Docmost uses the database for full-text search. You can optionally configure Typesense as the search driver for improved search performance and relevance.
95
+
96
+
### Using Typesense
97
+
```shell
98
+
SEARCH_DRIVER=typesense
99
+
TYPESENSE_API_KEY=xyz123
100
+
TYPESENSE_URL=http://localhost:8108
101
+
TYPESENSE_LOCALE=en
102
+
```
103
+
92
104
## Telemetry
93
105
We anonymously collect the active version, user count, page count, space and workspace count.
Docmost includes AI-powered features that help you write, edit, and search your workspace content. AI capabilities are available in two areas: the editor (Ask AI) and search (AI Answers). Since Docmost is self-hosted, you can choose to use cloud-based AI models (OpenAI, Google Gemini) or local LLMs (via Ollama) — keeping your data fully under your control.
8
+
9
+
:::note
10
+
AI is an enterprise feature. An active enterprise license is required. AI features also require an AI provider to be configured by a workspace admin. See the [AI Search Setup](/self-hosting/ai/ai-search) guide for provider configuration.
11
+
:::
12
+
13
+
## AI Settings (Admin)
14
+
15
+
Workspace admins can enable or disable AI features from **Settings** > **AI settings**. There are two independent toggles:
16
+
17
+
-**AI-powered search (AI Answers)** — Uses vector embeddings to provide semantic search capabilities across your workspace content. When enabled, users can ask natural language questions in the search dialog and receive AI-generated answers based on workspace pages.
18
+
-**Generative AI (Ask AI)** — Enables AI-powered content generation in the editor. When enabled, users can generate, improve, translate and transform text directly within the editor.
19
+
20
+
Each feature can be toggled on or off independently.
21
+
22
+
## Ask AI (Editor)
23
+
24
+
When Generative AI is enabled, an **Ask AI** button appears in the editor toolbar when you select text. You can also type a custom prompt in the **Ask AI...** input field to give the AI specific instructions.
25
+
26
+
### Available Actions
27
+
28
+
| Action | Description |
29
+
|--------|-------------|
30
+
|**Improve writing**| Refine and enhance the selected text |
31
+
|**Fix spelling & grammar**| Correct spelling and grammar errors |
32
+
|**Make longer**| Expand the selected text with more detail |
33
+
|**Make shorter**| Condense the selected text |
34
+
|**Continue writing**| Generate additional content from where the text ends |
35
+
|**Explain**| Provide an explanation of the selected text |
36
+
|**Summarize**| Create a summary of the selected text |
37
+
38
+
### Change Tone
39
+
40
+
Rewrite the selected text in a different tone:
41
+
42
+
- Professional
43
+
- Casual
44
+
- Friendly
45
+
46
+
### Translate
47
+
48
+
Translate the selected text into one of the supported languages:
When AI-powered search is enabled, an **AI Answers** toggle appears in the search dialog. With AI Answers turned on, you can ask natural language questions about your workspace content and receive AI-generated answers based on your pages.
55
+
56
+
To use AI Answers:
57
+
58
+
1. Open the search dialog (`Ctrl/Cmd + K`).
59
+
2. Toggle **AI Answers** on.
60
+
3. Type your question in the search field.
61
+
4. Click the **Ask** button or press Enter.
62
+
5. The AI returns an answer based on the content in your workspace.
63
+
64
+
AI Answers only searches content you have permission to access. Results are scoped to the spaces and pages visible to your account.
Docmost provides a REST API that allows you to programmatically interact with your workspace. You can create, read, update, and delete pages, spaces, and other resources. For the full API reference, see the [API documentation](https://docmost.com/api-docs).
8
+
9
+
:::note
10
+
The API is an enterprise feature. An active enterprise license is required.
11
+
:::
12
+
13
+
## API Keys
14
+
15
+
Each user can create personal API keys to authenticate with the API. API keys are scoped to the user who created them and inherit that user's permissions.
16
+
17
+
### Creating an API Key
18
+
19
+
1. Go to **Settings** > **API keys** (under Account).
20
+
2. Click **Create API Key**.
21
+
3. Enter a descriptive **Name** for the key.
22
+
4. Choose an **Expiration** period:
23
+
- 30 days
24
+
- 60 days
25
+
- 90 days
26
+
- 365 days
27
+
- Custom
28
+
- No expiration
29
+
5. Click **Create**.
30
+
31
+
The API key is displayed once after creation. Copy it and store it securely — it cannot be viewed again.
32
+
33
+
### Managing Your Keys
34
+
35
+
Your API keys are listed under **Settings** > **API keys** with the following details:
36
+
37
+
-**Name** — The descriptive name you assigned to the key.
38
+
-**Last used** — When the key was last used to make an API request.
39
+
-**Expires** — The expiry date, or "Never" if the key has no expiration.
40
+
-**Created** — When the key was created.
41
+
42
+
Click the **...** menu on any key to:
43
+
44
+
-**Rename** — Change the key's name.
45
+
-**Revoke** — Permanently revoke the key. This action cannot be undone.
46
+
47
+
## API Management (Admin)
48
+
49
+
Workspace admins can view and manage API keys for all users in the workspace.
50
+
51
+
1. Go to **Settings** > **API management** (under Workspace).
52
+
53
+
This page displays all API keys across the workspace, including the **User** who owns each key. Admins can create, rename, and revoke keys on behalf of any user.
-**Gantt chart** - Project timelines and scheduling
31
+
-**Pie chart** - Proportional data visualization
32
+
-**Git graph** - Git branching and commit history
33
+
-**Mindmap** - Hierarchical idea mapping
34
+
35
+
### Example
36
+
37
+
```
38
+
graph TD
39
+
A[Start] --> B{Decision}
40
+
B -->|Yes| C[Action 1]
41
+
B -->|No| D[Action 2]
42
+
C --> E[End]
43
+
D --> E
44
+
```
45
+
46
+
For full Mermaid syntax documentation, visit [mermaid.js.org](https://mermaid.js.org).
47
+
48
+
## Draw.io (diagrams.net)
49
+
50
+
Draw.io provides a full-featured visual diagram editor with drag-and-drop shapes, connectors, and styling options.
51
+
52
+
To insert a Draw.io diagram:
53
+
54
+
1. Type `/` and select **Draw.io (diagrams.net)**.
55
+
2. The Draw.io editor opens where you can create your diagram.
56
+
3. Click **Save** to embed the diagram in your page.
57
+
4. Double-click the diagram at any time to re-open the editor and make changes.
58
+
59
+
### Use Cases
60
+
61
+
- Network architecture diagrams
62
+
- Flowcharts and process maps
63
+
- Wireframes and mockups
64
+
- Organizational charts
65
+
- UML diagrams
66
+
67
+
## Excalidraw
68
+
69
+
Excalidraw is a whiteboard-style drawing tool that produces hand-drawn looking diagrams. It is ideal for quick sketches, brainstorming, and informal diagrams.
70
+
71
+
To insert an Excalidraw diagram:
72
+
73
+
1. Type `/` and select **Excalidraw**.
74
+
2. The Excalidraw whiteboard editor opens.
75
+
3. Use the toolbar to draw shapes, lines, text, and freehand sketches.
76
+
4. Click **Save** to embed the drawing in your page.
77
+
5. Double-click the drawing at any time to re-open the editor and make changes.
78
+
79
+
### Use Cases
80
+
81
+
- Quick sketches and brainstorming
82
+
- Architecture whiteboarding
83
+
- Informal diagrams and illustrations
84
+
- Collaborative visual thinking
85
+
86
+
## Technical Details
87
+
88
+
### Storage
89
+
90
+
All diagrams are stored as SVG files in the configured storage system. This means diagrams are resolution-independent and can be viewed without any special rendering. Users can continue to edit their diagrams at any time by double-clicking on them — the original editable data is preserved within the SVG.
91
+
92
+
### Built-in Editors
93
+
94
+
The Mermaid, Excalidraw, and Draw.io editors are all built into Docmost. No external services are required for Mermaid or Excalidraw.
95
+
96
+
For Draw.io, Docmost uses the default Draw.io editor via an iframe by default. If you are self-hosting and prefer to use your own Draw.io instance, you can configure it with the following environment variable:
0 commit comments