SiYuan(思源笔记):开源、隐私优先、自托管的知识工作空间
SiYuan 是一款隐私优先的个人知识管理系统,支持细粒度块级引用与 Markdown 所见即所得编辑,提供块级双向链接、SQL 查询嵌入、数据库表格视图、闪卡间隔重复、OpenAI API AI 写作与问答、Tesseract OCR 等能力;支持 Android/iOS/HarmonyOS 客户端、Docker/Unraid/TrueNAS 自托管部署、内置 CLI 与 API,大部分功能免费(含商用)。
社区作者 · zZz
它解决什么问题
项目定位
SiYuan 是一款**开源、隐私优先、自托管的知识工作空间**,定位为隐私优先的个人知识管理系统,支持细粒度块级引用与 Markdown 所见即所得编辑(配图 1 为项目标识;配图 3、配图 4 为功能截图;配图 5 为 SiYuan 架构示意;配图 6 为贡献者展示)。
核心功能(大部分功能免费,甚至可商用)
- 内容块:块级引用与双向链接、自定义属性、SQL 查询嵌入、siyuan:// 协议。
- 编辑器:块样式、Markdown 所见即所得、列表大纲、块放大、百万字大文档编辑、数学公式/图表/流程图/甘特图/时序图/五线谱、网页剪藏、PDF 标注链接。
- 导出:块引用与嵌入、带资源的标准 Markdown、PDF/Word/HTML、复制到微信公众号/知乎/语雀。
- 数据库:表格视图、闪卡间隔重复、通过 OpenAI API 的 AI 写作与问答、Tesseract OCR。
- 其他:多标签页与拖拽分屏、模板片段、JavaScript/CSS 代码片段、Android/iOS/HarmonyOS App、Docker 部署、API、社区集市。
- 部分功能仅对付费会员开放(详见 Pricing)。
架构与生态
- lute:编辑器引擎
- chrome:Chrome/Edge 扩展
- bazaar:社区集市
- dejavu:数据仓库
- petal:插件 API
- android / ios / harmony:移动端应用
- riff:间隔重复
数据存储方式
数据保存在工作空间 data 文件夹:assets(插入的资源)、emojis(表情图片)、snippets(代码片段)、storage(查询条件、布局、闪卡等)、templates(模板片段)、widgets(挂件)、plugins(插件)、public(公共数据);其余文件夹是用户创建的笔记本文件夹,笔记本中 .sy 后缀文件以 JSON 格式保存文档数据。
Docker 部署的已知限制
- 不支持桌面和移动应用连接,仅支持浏览器使用。
- 不支持导出 PDF、HTML 和 Word 格式。
- 不支持导入 Markdown 文件。
许可证说明
来源正文仅说明 SiYuan 完全开源(用户界面与内核、Android、iOS、HarmonyOS、Chrome 剪藏扩展均可贡献代码),但未给出具体许可证名称,故该字段标注为待核验。
— 本文由 AI 根据公开来源辅助整理,命令、版本与许可证请在使用前到原始页面复核。
安装 / 开始使用
一、准备环境与安装方式选择
官方建议:桌面端与移动端优先通过应用市场安装,以便后续一键升级版本。
- 应用市场
- 移动端:App Store、Google Play、F-Droid
- 桌面端:Microsoft Store
- 安装包(手动安装)
- B3log 官方下载
- GitHub Releases
- 包管理器
- 来源包管理器章节列出:siyuan、siyuan-note
步骤 4
Docker 自托管(推荐用于服务器)
二、Docker 部署步骤
镜像名称为 b3log/siyuan。程序整体位于容器内 /opt/siyuan/,结构基本对应 Electron 安装包 resources 目录:appearance(图标、主题、语言)、guide(用户指南文档)、stage(界面与静态资源)、kernel(内核程序)。 入口点为镜像构建时设置:ENTRYPOINT ["/opt/siyuan/entrypoint.sh"];该脚本可修改容器内运行用户的 PUID 与 PGID,用于解决挂载宿主目录时的权限问题。
注意:自 v3.7.0 起必须显式传入 serve 子命令(例如 docker run b3log/siyuan serve --workspace=...)。运行 docker run --rm b3log/siyuan serve --help 可查看全部服务参数。
主要参数:
--workspace:工作空间文件夹路径,通过宿主
