An open-source knowledge base and document management system that enables private deployment for individuals, teams, and organizations.
Home | Official Site | OSS Demo Site | Deployment Guide | User Manual | Document Examples
Source code：Gitee | GitHub | AtomGit
## Introduce MrDoc is a self-hostable online document and knowledge base system. It covers the full lifecycle of knowledge creation, document accumulation, knowledge organization, AI applications, knowledge publishing and continuous enrichment, helping teams and individuals build a complete knowledge management loop. ``` Knowledge Creation → Document Accumulation → Knowledge Organization → AI Applications → Knowledge Publishing → Continuous Enrichment ``` You can think of MrDoc as "Confluence without the per-seat billing, running from a single docker compose command" — one container, one mounted data directory, unlimited accounts on a one-time professional license. Everything you write can also become the knowledge source for your AI: retrieval and generation both run on your own infrastructure, with no data leaving your network. Supports Web, browser extensions, desktop client, mobile client and Obsidian sync plugin, and can be used for personal knowledge bases, team knowledge bases, product documentation and other scenarios. MrDoc currently provides the following clients and extensions: - 🌐Web: Open Source Edition and Professional Edition, [version comparison](https://mrdoc.pro/doc/3441/) - 💻Browser Extension: mainly for web clipping, quick notes and AI knowledge base Q&A; supports Chromium-based browsers and Firefox, [Download](https://gitee.com/zmister/mrdoc-webclipper)/[Chrome Web Store](https://chromewebstore.google.com/detail/mrdoc-%E9%80%9F%E8%AE%B0/aenkcglddghpaemlhefmhkdnhfceflcj)/[Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/dihimgafbjljdfanobikhnolpmjjhpic)/[Firefox Add-ons](https://addons.mozilla.org/zh-CN/firefox/addon/mrdoc-webclipper/) - 🗔Desktop Client: mainly for document editing and importing; supports Windows, macOS, Linux, [Download](https://mrdoc.pro/d/mrdoc-desktop-releases/) - 📱Mobile Client: mainly for personal knowledge base viewing, document editing and AI knowledge base Q&A; supports Android, [Download](https://mrdoc.pro/d/mobile-app-releases/) - Obsidian Sync Plugin: mainly for two-way sync between Obsidian documents and MrDoc documents [Tutorial](https://mrdoc.pro/doc/45650/) ## Applicable Scenarios MrDoc is designed for knowledge management and document collaboration scenarios for individuals, teams, and organizations. It has been adopted by many individual users, small and medium-sized teams, enterprises, research institutions, and organizations for knowledge management and document collaboration. ### 👤 Personal Knowledge Management - Personal notes and knowledge bases - Learning material organization - Technical documentation management - Personal wikis ### 🏢 Enterprise and Team Knowledge Management - Internal knowledge bases - Product documentation - Technical and development documentation - Project collaboration documents - Employee training materials - Customer service knowledge bases ### 🔬 Research Institutions and Laboratories - Research project documentation management - Experimental records organization - Research knowledge preservation - Knowledge sharing within research groups ### 🏛️ Government and Public Organizations - Departmental knowledge bases - Workflow documentation - Business document management - Organizational experience sharing ### 🎓 Educational Institutions - Teaching material management - Course document sharing - Academic team collaboration ### 🌐 Product and Content Publishing - Product documentation sites - Online help centers - Open-source project documentation - Technical blogs ## Feature Overview ### Document & Knowledge Management | Capability | Details | | ---- | ---- | | Document Editing | Supports Markdown, rich text and spreadsheet documents, along with editors such as Editor.md, Vditor and iceEditor; supports images, attachments, formulas, audio and video, mind maps, flow charts and ECharts diagrams | | Document Management | Supports document hierarchy, sorting, tags, templates, historical versions and recycle bin | | Project Management | Supports project creation, sorting, export, transfer and collaborator management | | Permission Control | Supports multiple access permissions such as public, private, specified users and access codes | ### AI Capabilities | Capability | Details | | ---- | ---- | | AI Knowledge Base | AI Q&A based on document content and permissions, for fast retrieval and understanding of knowledge | | AI Writing | Supports AI document writing, continuation and text polishing | | AI API | Supports accessing AI capabilities and third-party applications through Token API | ### Reading & Publishing | Capability | Details | | ---- | ---- | | Document Reading | Two-column reading layout, three-level outline, font settings and day/night modes, adapted for mobile | | Content Search | Supports document full-text search and tag relationship network | | Content Sharing | Supports document share codes, favorites and Markdown download | | Project Publishing | Supports PDF and EPUB generation and download, as well as project export | ### SEO & GEO | Capability | Details | | ---- | ---- | | SEO Optimization | Supports search engine indexing optimization, robots.txt, Canonical and JSON-LD structured data | | GEO Optimization | Supports mechanisms such as llms.txt, providing an entry point to site content for AI search and large language models | ### Management & Deployment | Capability | Details | | ---- | ---- | | Site Management | Provides unified management of users, projects, documents, images, attachments and site configuration | | Access Control | Supports registration invitation codes, login captcha, disabling registration and forced login | | API | Provides Token API, supporting editing, retrieving and searching documents through the API | | Self-hosting | Supports deployment on personal computers, NAS, servers and corporate intranets, with data fully controlled by the user | For the complete update record, see: [CHANGES.md](./CHANGES.md) ## Example Site Open Source Edition: [https://demo.mrdoc.io](http://demo.mrdoc.io) Professional Edition: [https://pro.mrdoc.io](https://pro.mrdoc.io) Comparison between the Open Source Edition and the Professional Edition - [https://mrdoc.io/doc/362/](https://mrdoc.io/doc/362/) username: test1 password: 123456 ## Docker Compose Deployment ### 1、Deployment ``` git clone https://gitee.com/zmister/mrdoc-install.git && cd mrdoc-install && chmod +x docker-install.sh && ./docker-install.sh ``` ### 2、Update If a new version is available, simply run the `docker-update.sh` script in the MrDoc project directory to complete the update. ## Windows Deployment Panel Even without a Linux server or dedicated technical staff, you can still build your own MrDoc AI knowledge base on Windows. Visual operation interface, no need to install any extra environment or dependencies, no need to enter any commands, supports runserver/Waitress modes and provides production-grade deployment capabilities. User Manual: https://mrdoc.pro/d/windows-deploy-panel/ Download and update notes: https://mrdoc.pro/d/windows-panel-log/ ### More Deployment Methods See the deployment documentation for details: https://mrdoc.pro/doc/1362/ ## Deployment Tools - [Official Docker Image](https://hub.docker.com/r/zmister/mrdoc) - [Docker Compose One-Click Deployment](https://mrdoc.pro/doc/45758/) - [Docker Image By jonnyan404](https://registry.hub.docker.com/r/jonnyan404/mrdoc-nginx) - [~~Linux Deployment Script By jonnyan404~~](https://gitee.com/jonnyan404/oh-my-mrdoc) - [Windows Deployment Panel](https://mrdoc.pro/d/windows-deploy-panel/) - [VirtualBox/VmWare Image By 无名](https://gitee.com/nicktf/tinycore-mrdoc) ## Document Import Tools - [MrDoc Desktop Client](https://mrdoc.pro/doc/4031/) - ~~[MrDoc Import Toolbox](https://gitee.com/zmister/mrdoc-import-toolbox)~~ ## Other Tools - [Local Document Synchronization Tool By Atyin](https://gitee.com/atyin/mrdocTools) ## Feedback
