# Docmost — Open Source Collaborative Wiki & Documentation

> Docmost is an open-source Confluence and Notion alternative for team wikis and documentation, featuring real-time collaboration, rich editor, and permission management.

## Install

Save as a script file and run:

## Quick Use

```bash
git clone https://github.com/docmost/docmost.git
cd docmost
cp .env.example .env
docker compose up -d
```

Open `http://localhost:3000` — set up your workspace and start creating documentation.

## Intro

**Docmost** is an open-source collaborative wiki and documentation platform designed as a self-hosted alternative to Confluence and Notion. Built with a modern tech stack (NestJS + React), it provides real-time collaborative editing, nested page organization, rich media support, and workspace-level permissions for team knowledge management.

With 19.7K+ GitHub stars and AGPL-3.0 license, Docmost offers organizations a way to maintain their knowledge base with full data ownership and no per-seat licensing fees.

## What Docmost Does

Docmost provides enterprise-grade documentation features:

- **Real-time Collaboration**: Multiple users can edit the same page simultaneously with live cursors and presence indicators
- **Rich Editor**: Block-based editor with Markdown shortcuts, tables, code blocks, callouts, and embeds
- **Nested Pages**: Infinite page nesting with drag-and-drop reordering in the sidebar
- **Spaces**: Organize documentation into separate spaces (Engineering, Product, HR, etc.) with independent permissions
- **Permissions**: Role-based access control at workspace, space, and page levels
- **Comments & Mentions**: Inline comments on any page content with @mention notifications
- **Search**: Full-text search across all pages with instant results
- **Page History**: Version history with diff view and restore capability

## Architecture

```
┌──────────────┐     ┌──────────────┐     ┌──────────────┐
│  React       │────▶│  NestJS      │────▶│  PostgreSQL  │
│  Frontend    │     │  API Server  │     │  (Prisma)    │
└──────────────┘     └──────┬───────┘     └──────────────┘
                            │
                     ┌──────┴───────┐
                     │  Redis       │
                     │  (Sessions & │
                     │   Realtime)  │
                     └──────────────┘
```

## Self-Hosting

### Docker Compose (Recommended)

```yaml
services:
  docmost:
    image: docmost/docmost:latest
    ports:
      - "3000:3000"
    environment:
      APP_URL: http://localhost:3000
      APP_SECRET: your-random-secret-key
      DATABASE_URL: postgresql://docmost:docmost@db:5432/docmost
      REDIS_URL: redis://redis:6379
    depends_on:
      - db
      - redis

  db:
    image: postgres:16-alpine
    environment:
      POSTGRES_USER: docmost
      POSTGRES_PASSWORD: docmost
      POSTGRES_DB: docmost
    volumes:
      - pg-data:/var/lib/postgresql/data

  redis:
    image: redis:7-alpine
    volumes:
      - redis-data:/data

volumes:
  pg-data:
  redis-data:
```

## Key Features

### Block-Based Editor

The editor supports a wide range of content blocks:

- **Text**: Headings (H1-H6), paragraphs, quotes, callouts
- **Lists**: Bullet, numbered, toggle, task lists
- **Media**: Images, videos, file attachments with drag-and-drop upload
- **Code**: Syntax-highlighted code blocks with 100+ language support
- **Tables**: Full-featured tables with column resize and sorting
- **Embeds**: YouTube, Loom, Figma, Miro, and custom iframe embeds
- **Math**: LaTeX math equations (inline and block)
- **Diagrams**: Mermaid and Draw.io diagrams rendered inline

### Space Organization

```
Workspace
├── Engineering Space
│   ├── Architecture
│   │   ├── System Overview
│   │   └── API Design
│   ├── Runbooks
│   └── Onboarding
├── Product Space
│   ├── PRDs
│   └── Research
└── Company Space
    ├── Policies
    └── Handbook
```

### Import & Export

- Import from Confluence (XML export)
- Import from Notion (HTML/Markdown export)
- Export pages as Markdown or PDF
- Bulk export entire spaces

## Docmost vs Alternatives

| Feature | Docmost | Confluence | Notion | Outline |
|---------|---------|------------|--------|---------|
| Open Source | Yes (AGPL-3.0) | No | No | Yes (BSL) |
| Self-hosted | Yes | Data Center | No | Yes |
| Real-time collab | Yes | Yes | Yes | Yes |
| Nested pages | Yes | Yes | Yes | Yes |
| Spaces | Yes | Yes | Teamspaces | Collections |
| Pricing | Free (self-host) | Per user | Per user | Free (self-host) |
| Import from Confluence | Yes | N/A | Limited | Yes |

## FAQ

**Q: What team sizes is Docmost suitable for?**
A: From small teams to organizations with hundreds of people. The PostgreSQL backend ensures good scalability. If you have 100+ concurrent editors, consider increasing Redis and application-tier resources.

**Q: Can I migrate from Confluence?**
A: Yes. Docmost supports importing XML files exported from Confluence, including page hierarchy, attachments, and basic formatting. Complex Confluence macros may require manual adjustment.

**Q: SSO/LDAP support?**
A: Supports SAML SSO and Google OAuth login. LDAP support is on the roadmap.

## Source & Thanks

- GitHub: [docmost/docmost](https://github.com/docmost/docmost) — 19.7K+ ⭐ | AGPL-3.0
- Website: [docmost.com](https://docmost.com)

---
Source: https://tokrepo.com/en/workflows/docmost-open-source-collaborative-wiki-documentation-d505e49b
Author: Script Depot