首页 / 详情
Site icon

MrDoc

基本信息

MrDoc 网站截图预览

工具详情

MrDoc 觅思文档指南

一、平台介绍

MrDoc 觅思文档(又称觅道文档) 是一款国产开源的私有化部署知识库与在线文档系统。该系统基于 Python + Django + LayUI 技术栈开发,是 Gitee 2020 年度 GVP 开源项目。

1. 核心定位

  • 数据自主可控:支持本地、内网或公网私有化部署,无平台云端托管。
  • 安全隔离:所有文档、素材存储于用户自己的服务器或设备,有效规避 SaaS 平台关停风险及数据泄露隐患。
  • 版本迭代:提供开源免费版与商业专业版两大版本,Web 端每月持续更新。
  • 部署灵活:支持 Windows/Linux/macOS/NAS/宝塔面板/Docker 等环境,支持内网离线隔离网部署。

2. 技术架构

  • 开发语言:Python (Django)
  • 前端框架:LayUI
  • 协议标准:开源项目遵循 GPLv3 协议(需视商用情况开源修改代码)

二、核心主要功能

1. 文档创作(三大编辑器)

  • Markdown 编辑器:支持思维导图、流程图、ECharts 图表、LaTeX 科学公式、序列图、音视频嵌入、代码高亮及特殊符号(上下标/删除线/表格);内置 Vitor/iceEditor 富文本双编辑器可选。
  • 富文本编辑:类 Word 可视化排版,无需代码门槛,适合非技术人员。
  • 在线 Office(OnlyOffice):支持在线编辑 Word/Excel/PPT 文件,提供在线预览、修改及保存功能。
  • 在线表格:类 Excel 结构化数据管理,适用于台账、清单记录。

2. 文集 & 文档管理

  • 书籍式树形结构:支持无限层级“文集(书本)+ 子文档(章节)”,支持拖拽排序、上下级绑定。
  • 版本控制:支持文档历史版本回溯、回收站恢复、文档复制/移动/转让。
  • 辅助功能:支持文档标签、别名设置、目录自动生成、快捷链接及批量管理。
  • 导出功能:支持文集整站导出 PDF/电子书,单文档导出多格式。

3. 精细化权限管控(核心优势)

  • 多级权限:支持浏览/只读/编辑/协作/私密等分级权限设置。
  • 灵活控制:支持游客只读、指定成员协作、文档禁止复制、页面水印、全站关闭注册/强制登录。
  • 分享机制:可单独设置单篇文档对外分享链接(支持设置访问密码与时效)。

4. 全终端多端同步

  • Web 端:主流浏览器网页访问。
  • 客户端:支持 Windows/macOS/Linux 桌面客户端。
  • 移动端:支持安卓 APP。
  • 插件生态:Chrome/Firefox 浏览器插件(网页剪藏、一键保存);Obsidian 插件(双向同步本地笔记与在线文档)。

5. 素材 & 存储管理

  • 统一素材库:图片/附件集中管理,自定义附件白名单及单文件上传大小限制。
  • 存储方案:
  • 开源版:仅本地服务器存储文件。
  • 专业版:支持对接阿里云/腾讯 OSS 对象存储。
  • 预览能力:支持 PDF/Office/主流文本附件在线预览。

6. 第三方集成能力

  • 单点登录 (SSO):支持企业微信、钉钉、LDAP、OIDC 等第三方登录,企业组织架构一键导入。
  • AI 能力:接入 Dify 大模型框架,内置 RAG 私有知识库;支持文档喂给 AI 进行私有知识库问答、AI 辅助写作、文档总结、语义检索及内容润色/翻译(私有化大模型,不上传原文至第三方)。
  • 消息推送:支持 WebHook 消息推送,文档变更可推送至钉钉/企业微信。

7. 数据导入迁移

  • 批量导入:支持 Joplin、印象笔记、Obsidian 文档批量导入。
  • 开放接口:开放 API 与 Token 接口,支持自研系统对接 MrDoc 进行文档读写。

三、适用人群 & 使用场景

1. 个人用户

  • 场景:程序员笔记、自学知识库、读书笔记、个人项目文档、私密随笔。
  • 价值:替代本地 Word/零散记事本,实现云端私有化存储笔记。

2. 研发/技术团队

  • 场景:开发手册、接口文档、运维手册、故障台账、技术沉淀知识库。
  • 价值:内网部署杜绝代码/方案外泄。

3. 产品/中小企业

  • 场景:产品帮助手册、内部制度文档、员工培训教程、客服知识库、对外官网帮助中心。
  • 价值:结构化发布,公网部署可开放访客查阅。

4. 培训机构/自媒体

  • 场景:在线课程文档、教程知识库、付费专栏文档。
  • 价值:书籍化结构化发布教程,方便学员查阅。

5. 政企涉密单位

  • 场景:内网隔离网私有化部署,涉密资料本地留存。
  • 价值:满足数据合规要求,不经过公有云。

四、免费 & 付费版本详情

✅ 开源版(永久免费,GPLv3 开源协议)

适用对象:个人用户、5 人以内小型团队。

  1. 授权方式:免费永久使用,无期限、无用户数限制;源码开放可自行二次修改。
  2. 标配功能:Markdown/富文本/在线表格、基础权限、Web 端、本地文件存储、基础附件管理。
  3. 功能限制:
  • 无全平台客户端(桌面/APP/插件)。
  • 无 OSS 云存储支持。
  • 无官方技术支持。
  • AI/Dify 集成受限。
  • 无企业级单点登录增强功能。
  • 无批量用户导入、无高级水印/防爬配置。

💳 专业版(商业付费,永久授权)

适用对象:中大型企业、全终端使用需求、需要 AI/OSS/企业集成的团队。

  1. 授权方式:付费买断制,永久使用权,无年费、无用户上限(具体报价咨询客服)。
  2. 解锁功能:
  • 全平台支持(桌面端 +APP+ 浏览器插件+Obsidian 插件)。
  • OSS 对象存储支持。
  • 完整 Dify+ 私有 RAG AI 能力。
  • 全量第三方认证(钉钉/企微/LDAP/OIDC 全功能)。
  • 高级权限、批量用户导入、专属技术售后、版本优先更新。
  • 付费代部署服务(适合 0 基础用户,远程协助 Docker/宝塔一键部署)。
重要提示:无官方 SaaS 云端版,所有版本必须自行部署在自己服务器/电脑/NAS,官方不提供云端托管服务。

五、详细使用教程

方式 1:Docker 一键部署(新手首选,推荐)

适用环境:Linux/Windows/Docker 环境。

  1. 安装环境:确保服务器已安装 Docker。
  2. 拉取镜像:
  3. bash
docker pull zmister/mrdoc:latest
docker pull zmister/mrdoc:latest
  1. 启动容器(映射端口 10086,可自定义):
  2. bash
docker run -d --name mrdoc -p 10086:10086 -v /opt/mrdoc-data:/app/MrDoc zmister/mrdoc:latest
docker run -d --name mrdoc -p 10086:10086 -v /opt/mrdoc-data:/app/MrDoc zmister/mrdoc:latest
  1. 创建管理员账号:
  2. bash
docker exec -it mrdoc python manage.py createsuperuser
docker exec -it mrdoc python manage.py createsuperuser
  1. 访问系统:浏览器输入 http://服务器 IP:10086,使用管理员账号登录。

方式 2:源码手动部署(开发者自定义修改)

适用对象:有开发基础,需深度定制系统。

  1. 克隆源码:
  2. bash
git clone https://gitee.com/qizhenghai/MrDoc.git
git clone https://gitee.com/qizhenghai/MrDoc.git
  1. 安装依赖:
  2. bash
pip install -r requirements.txt
pip install -r requirements.txt
  1. 初始化数据库:
  2. bash
python manage.py makemigrations && python manage.py migrate
python manage.py makemigrations && python manage.py migrate
  1. 创建管理员:
  2. bash
python manage.py createsuperuser
python manage.py createsuperuser
  1. 启动服务:
  2. bash
python manage.py runserver 0.0.0.0:10086
python manage.py runserver 0.0.0.0:10086

基础入门使用步骤

  1. 后台配置:管理员登录后台→站点设置,配置站点名称、附件大小/格式白名单;设置是否开启注册;用户管理创建成员账号、设置分组权限。
  2. 创建文集:首页→新建文集(如「产品手册」「技术文档」),设置文集权限(私密/全员可读/指定协作)。
  3. 新建文档:进入文集→新建文档,选择 Markdown/富文本/表格/Office,插入图表、附件、图片,保存发布。
  4. 分享文档:文档右上角点击分享,生成链接 + 访问密码,发给外部人员。
  5. 多端同步:下载官网对应客户端,登录同账号自动同步全部知识库。

六、部署&使用避坑清单

一、部署避坑

  1. 端口占用:默认端口 10086 易被占用,启动 Docker 时务必修改映射端口(如 -p 8080:10086)。云服务器安全组需放行对应端口,否则外网无法访问。
  2. 数据备份:Docker 部署必须挂载数据卷(-v 本地路径:/app/MrDoc),若未挂载,容器删除后数据全丢。需定期备份挂载目录文件与数据库 SQL。
  3. 数据库选型:小型部署默认 SQLite 够用;超过 20 人团队建议配置 MySQL。开源版可自行修改配置切换,切勿后期临时迁移数据库。
  4. NAS 部署:极空间/群晖 NAS 用 Docker 部署时,优先使用官方镜像,避免使用第三方修改镜像导致兼容性 BUG。

二、功能使用避坑

  1. 开源版存储:开源版文件全存服务器本地磁盘,大量附件会占满硬盘。如需使用 OSS 云存储必须升级专业版,不要自行魔改源码对接 OSS(可能违反 GPL 协议)。
  2. OnlyOffice 配置:OnlyOffice 需单独部署服务,新手不要自行配置,极易出现跨域、预览失败。建议优先使用专业版官方配置或付费代部署。
  3. AI 接入限制:Dify+ 私有 RAG 需要额外部署 Dify 服务,开源版 AI 功能阉割。若需完整私有知识库问答,建议直接升级专业版,避免浪费时间配置无效功能。
  4. 权限误区:文集权限优先级>单文档权限。若文集设为私密,单文档单独开放分享链接不生效。需先放开文集浏览权限再设置文档分享。
  5. 浏览器插件:剪藏插件仅支持 Chromium 内核浏览器(Chrome/Edge),Firefox 部分功能缺失。复杂格式剪藏易乱码,建议复制正文到编辑器。
  6. 版本升级:Docker 容器升级优先拉取新镜像并保留数据卷,不要直接在容器内升级代码,极易环境崩坏;源码部署升级前务必备份数据库。

三、合规避坑

  • GPLv3 协议:开源版遵循 GPLv3 协议。若二次修改源码并对外商用分发,必须开源修改后的代码;仅企业内部自用修改源码无需开源。

七、官方资源入口

  • 官方网站:https://www.mrdoc.pro
  • 官方使用手册:https://doc.mrdoc.pro/p/user-guide/
  • 部署文档:https://doc.mrdoc.pro/p/deploy/


评论

暂无评论