nowen-note

cropflreGPL-3.0活跃维护

开源自托管的笔记与私有知识库,支持 Markdown/富文本、AI 写作、思维导图、任务管理和全文搜索,Docker 一键部署,适合在 NAS 上搭建个人知识库。

开源自托管笔记与私有知识库,支持 Markdown/富文本、AI 写作、思维导图、任务管理、全文搜索、多级笔记本和 Docker 一键部署。

v1.5.5发布于 2026-11-09 07:33 UTC617star +9 / 7 天96fork同步于 2026-11-10 17:57 UTC

怎么上手

由 README 提炼,执行前请确认
git clone https://github.com/cropflre/nowen-note.git
cd nowen-note
docker compose up -d
硬件要求按 README 说明

README 未说明显存或 GPU 要求;服务端以 Docker 部署,镜像可构建 amd64、arm64 或多架构版本,可跑在 NAS(绿联 UGOS、飞牛 fnOS)与群晖、威联通等设备上。桌面端最低要求 macOS 12(Monterey)。

有 Docker 镜像
下载:源码 zip·GitHub Releases(安装包)本站不镜像安装包

项目说明

由 README 自动翻译提炼

开源自托管的笔记与私有知识库,把笔记、任务、AI 问答统一在一棵知识树里

开源自托管的笔记与私有知识库,支持 Markdown/富文本、AI 写作、思维导图、任务管理和全文搜索,Docker 一键部署,适合在 NAS 上搭建个人知识库。

核心能力

  • 用统一知识树混合组织文件夹、富文本与 Markdown 文档
  • Tiptap 3 与 CodeMirror 6 双编辑器支持格式互转与实时预览
  • RAG 问答先在本地索引检索片段再发给大模型
  • Yjs + WebSocket 实现实时协作与目录级 ACL 权限
  • 附件可存本地磁盘、S3、R2 或 MinIO,支持 WebDAV 远程备份

容易踩的坑

默认管理员账号为 admin/admin123,首次登录后须立即修改密码;容器持久化根目录是 /app/data 而非 /data,升级前要先做完整备份,镜像回滚不会还原数据库;公网部署需自行配置 HTTPS 与 PUBLIC_WEB_ORIGIN,否则分享链接可能不正确。

内容由模型根据 README 生成,可能不完整或不准确,以官方文档为准。看原文 README

最近发版

5 个版本v1.5.5
  1. v1.5.5v1.5.5 · 双向同步与桌面体验升级最新正式版2026-11-09 · 2026-11-09 07:33 UTC

    ✨ 更新亮点

    Nowen Note v1.5.5 正式发布! 本次重点优化多端同步、知识树冲突处理和桌面端稳定性,并带来更加统一、流畅的交互体验。

    🔄 Web / PC / Android 双向同步

    • 优化在线变更通知,正在编辑或查看的笔记可自动接收其他设备的更新(#910)。
    • 改进多端并发编辑处理,保留双方正文,避免内容被静默覆盖。

    🗂️ 知识树与多设备冲突修复

    • 加强目录结构差异的修复前检查与操作确认。
    • 优化多设备登录后的新手引导状态,减少重复引导和结构冲突带来的干扰。

    🖥️ 桌面端稳定性提升

    • 优化首次同步下载进度、本地账号登录恢复及失败重试。
    • 修复桌面后端启动异常后的恢复流程,改善 Lite 版启动体验。

    🎨 界面动效与编辑体验

    • 引入统一交互动效设计系统,优化页面切换和界面反馈。
    • 修复窗口缩放后的工作区布局、手机端分享弹窗裁切。
    • 改进 Word 图片粘贴、Markdown 换行显示及文件图片链接复制。

    🛠️ 兼容性与其他改进

    • 完善 AI 生成内容标识、个人日记接口权限校验和鸿蒙导出。
    • 改进历史数据库迁移、账号验证和备份时间显示。

    📦 下载与升级

    支持 Windows、macOS、Linux、Android、飞牛 fnOS、绿联 UGOS、Docker 及浏览器剪藏插件。

    官网下载中心 · 完整更新日志 · 问题反馈

    升级提醒: 升级前请备份数据库、附件及部署配置。回退客户端或 Docker 镜像不会回滚持久化数据库。实时双向同步需要设备在线并连接同一服务端与账号,网络中断和真正的并发冲突仍可能需要用户处理。

    安装包签名: GitHub 发布的 macOS 安装包未进行 Apple Developer ID 签名或公证,可能触发 Gatekeeper 提示;Windows GitHub 直接下载 EXE 也未提供代码签名,请从官方渠道获取。

    • 发布日期:2026-11-09
    • 源码提交:41177ba40f56eecaddb03d7b2f2b30d8ceb4c9ee
    • 正式构建记录
    • Workspace、个人应用 Studio 和扩展平台 V3 仍属于 v1.6.0 规划,不在本次版本交付范围内。

    飞牛 FPK 更新日志修订包(v1.5.5-fpk-r1)

    • 修复:飞牛版应用内「更新日志」补齐 v1.5.5、v1.5.4,精简 v1.5.3 英文提交记录。

    • 新版 FPK:nowen-note-1.5.5-fpk-r1.fpk,镜像 cropflre/nowen-note:v1.5.5-fpk-r1(仅 fnOS x86_64)。

    • 保留原版:旧 nowen-note-1.5.5.fpk 与正式 Docker v1.5.5 不变,修订包需要手动选择下载。

    • 升级提示:升级前备份数据库、附件与部署配置;镜像回退不会回滚数据库。fnOS 对同版本覆盖安装的处理以应用中心支持为准。

    • 修订来源:bed607c417aa2d31435de968ebeeda802b400579;并未重新发布其他平台安装包。

  2. v1.5.42026-11-02 · 2026-11-02 07:49 UTC
    查看更新说明

    Nowen Note v1.5.4|AI 写作、Markdown 折叠与离线体验升级

    这次更新聚焦日常写作与多端使用:长文档更容易导航,AI 修改可以先预览再确认,图片预览、附件上传和 NAS 离线使用更加稳定。

    AI 协作,先看方案再应用

    • 编辑器内加入 AI 助手,结合当前笔记和选区生成修改建议,预览、确认后再应用到正文。
    • 笔记本 Agent 支持按范围整理资料、生成笔记和任务草稿;应用前可逐项检查、筛选并确认。
    • 支持自定义 Skills,在 AI 对话和编辑器助手中复用写作要求与处理步骤。Skills 仅提供指令,不运行脚本或额外获取权限。
    • 管理员可配置共享 AI 模型并授权成员使用,API 密钥保留在服务端;同时改进自定义网关请求头、Anthropic Messages 接口和模型连接诊断。

    长篇 Markdown,更容易阅读和编辑

    • 新增章节折叠,支持标题层级、折叠栏和桌面快捷键;折叠只改变视图,不改写正文。搜索命中隐藏内容时会自动展开。
    • 修复 Live 模式中打开、关闭图片预览时的闪烁,改进附件链接打开与访问授权。
    • 增强 Mermaid 对流程图标签括号和独立 // 注释的兼容性。

    图片与附件,交互更稳、显示更清楚

    • 改进全屏图片的缩放、拖动、双指手势、横竖屏切换及多图浏览,减少拖动误关闭和手势状态残留。
    • 全屏预览使用已授权的原始分辨率附件地址,避免沿用缩略图;修复图片解码前比例判断导致的显示失真。
    • 附件上传后即使响应丢失,也可找回已保存文件的准确身份,减少重复上传和失效引用。
    • 缩短稳定附件分享链接,增强 HEIC/HEIF 兼容预览。

    NAS 与离线使用,减少手动操作

    • 桌面完整版登录 NAS 后可自动准备个人笔记和受管附件的本地副本;首次下载完成后,断网仍可继续阅读和编辑。
    • 恢复连接后自动回传待同步修改,下载中断支持重试;旧版未确认写入和冲突继续保留,不通过清空队列掩盖问题。
    • 加强 Android 本地优先模式下的附件下载、账号切换、离线重开和重连同步处理。

    导入、界面与兼容性

    • Word(DOCX)导入文件大小上限提高到 1 GB,保留解压和内容安全校验。
    • 改进浏览器剪藏图片的 Referer 规则隔离,减少并发剪藏之间的相互影响。
    • 优化移动端 AI 设置和助手面板,改善大字体下的笔记卡片显示,并新增 Microsoft Store 下载入口。
    • 更新 Node.js、Electron 和 React 运行时;完善数据库版本不兼容提示、升级保护和 SDK 独立构建。

    升级前请确认

    本次 macOS 包未做 Developer ID 签名和 Apple 公证;Windows GitHub 直接下载包也未提供代码签名。 macOS 首次打开可能被系统阻止,请先核对下载来源和文件校验信息,再按系统提示处理。Android 沿用原发布签名并校验证书摘要。

    1. 先备份,再升级。 完整备份数据库、附件和部署配置,并保留可独立恢复的副本。回滚客户端或 Docker 镜像不会自动回滚数据库;需要降级时,应使用升级前的完整备份。
    2. 桌面安装包自带运行时,无需另装 Node.js。新版 macOS 桌面包要求 macOS 12+;在 macOS 上独立运行源码、CLI 或 MCP 时,官方 Node 24 二进制要求 macOS 13.5+。
    3. NAS 离线增强主要覆盖个人笔记和受管附件,不等于共享空间、独立文件管理、任务和脑图均已支持完整离线使用。首次下载仍需联网,桌面 Lite 不包含本地后端。
    4. Workspace、个人应用 Studio 和扩展平台 V3 仍属于 v1.6.0 规划,不作为本次新增交付。

    下载平台和架构请以本次 GitHub Release 的实际附件为准。Microsoft Store、TestFlight 及其他商店的审核与上架进度独立于 GitHub 和 Docker 发布。

    English summary

    Nowen Note v1.5.4 adds reviewable AI editing, notebook-scoped draft workflows, reusable instruction-only Skills and administrator-managed shared model profiles. Markdown gains chapter folding with automatic search reveal. Image viewing, attachment recovery after lost upload responses, HEIF previews and NAS offline copies are improved. DOCX imports now allow files up to 1 GB, and browser clipping better isolates concurrent image requests.

    Back up the database, attachments and deployment configuration before upgrading. Rolling back an app or image does not roll back persisted data. This release's macOS packages are not Developer ID signed or Apple notarized; Windows direct downloads are also unsigned. macOS desktop packages require macOS 12+; standalone source, CLI and MCP use with official Node 24 binaries requires macOS 13.5+. Workspace, Personal App Studio and Extension Platform V3 remain planned for v1.6.0. Available downloads are defined by this release's actual assets; store publication is separate.

    源码:de3da1e0c6c99afc42a2af3f285df19900943b66 构建:https://github.com/cropflre/nowen-note/actions/runs/41402498836

    Windows 直接下载包未提供代码签名。Store、TestFlight 使用独立渠道。


    FPK 简介更新(2026-11-02)

    FPK 已重新打包,应用简介补充本次 AI 协作、Markdown 折叠、图片附件、NAS 离线和 DOCX 导入等更新要点。应用文件及部署配置保持一致,继续使用 cropflre/nowen-note:v1.5.4 镜像;其他附件保持不变。此 FPK 为发布后的简介补包,校验值以此处为准。

    FPK SHA-256:4895315eee9fbd6543dffdb00d1ab9f4d9e58b31c76eb4fcf9aa39763cd1a6ac

    简介模板提交


    桌面版热修复补包(2026-11-02)

    仅重新打包 Windows Full/Lite、macOS Intel/Apple Silicon 安装包及对应更新元数据;保留原 v1.5.4 标签、其他平台产物和 Docker 镜像。修复首次 NAS 下载进度、失败重试及继续在线使用入口。

    热修复源码:0194596f;回归及构建验收。

    已安装 1.5.4 的用户需要重新下载安装包;相同版本号通常不会触发自动更新。

  3. v1.5.32026-10-23 · 2026-10-23 15:01 UTC
    查看更新说明

    🚀 Nowen Note v1.5.3 正式发布

    2026 年 10 月 23 日 · 体验优化与稳定性更新

    这一次,我们把重点放在日常使用体验上,让笔记编辑更顺手、文件管理更安心、多端使用更稳定。

    ✨ 本次更新亮点

    • 📝 笔记体验优化:新增收藏笔记搜索,修复多级目录拖拽错位、移动端代码块及斜杠菜单问题。
    • 🖼️ 图片管理增强:支持一键扫描并转存外链图片,优化图片旋转保存和分享链接。
    • 🔐 加密笔记升级:支持永久解除整篇笔记加密,管理更加灵活。
    • 📅 日历与任务优化:新增中国大陆节假日显示,优化 PushPlus 中文通知、任务提醒和时间处理。
    • 🛠️ 稳定性提升:修复多项编辑、同步及平台兼容性问题,完善多平台构建与发布流程。

    📦 下载与体验

    🌐 官方网站: https://nowen.cn/

    📥 多平台下载: https://nowen.cn/#/note/download

    💻 GitHub: https://github.com/cropflre/nowen-note

    支持 Windows、macOS、Linux、Android 及 Docker / NAS 部署。


    💡 下一版本预告: v1.6.0 将重点开发 Workspace 工作台、个人应用 Studio 与插件扩展平台 V3。

    感谢每一位提供反馈、提交 Issue 和参与贡献的朋友!❤️

    让记录更自由,让知识更有价值。

  4. v1.5.22026-10-16 · 2026-10-16 15:05 UTC
    查看更新说明
  5. v1.5.12026-10-08 · 2026-10-08 16:17 UTC
    查看更新说明

    🚀 Nowen Note v1.5.1

    2026-10-08 · 功能增强与稳定性更新

    本次更新重点优化任务管理、AI 能力、移动端体验及数据安全。

    ✨ 更新亮点

    • 📅 任务管理:新增到期排序、定时提醒、早晚任务摘要及 Webhook 推送。
    • 🤖 AI 与 MCP:支持查询任务进度,通过 AI 创建、完成任务,增强 Agent 集成能力。
    • 📱 移动端优化:修复 Android 同步闪退、笔记访问异常,改善局域网连接与账号切换。
    • ✍️ 编辑与安全:增强富文本编辑、Markdown 渲染及笔记加密保护。
    • 🛠️ 问题修复:优化备份恢复、附件加载、登录体验及多语言支持。

    📦 升级说明

    升级前建议做好完整数据备份,Docker / NAS 用户请确保数据库及附件已持久化。

    感谢大家持续反馈与支持!❤️

    完整更新记录: [v1.5.0...v1.5.1](https://github.com/cropflre/nowen-note/compare/v1.5.0...v1.5.1)

用户点评

登录用户的真实使用记录,可按版本和硬件筛选
共 0 条

    还没有人点评。第一个说出真实体验的人最有价值。

    README 原文

    未翻译

    GitHub Release Docker Pulls License: GPL v3 Node.js 24.22.1+(24.x LTS) Docker

    Nowen Note 不只是一个编辑器。它希望成为一套由你掌控数据、可长期运行在 NAS / 服务器上,并能通过 Web、桌面端和移动端随时访问的个人与团队知识基础设施。

    NAS 远程连接登录:支持部署到 绿联 NAS(UGOS / UGOS Pro) 和 飞牛 NAS(fnOS)。部署完成后,可在 Web、桌面端或 Android 客户端中,通过局域网 IP、IPv6 地址或已配置 HTTPS 的公网域名远程连接并登录。

    v1.5.4 更新亮点 · 2026-11-02

    AI 写作、Markdown 折叠与离线体验升级。 完整文案见 v1.5.4 更新说明;正式发布状态、下载平台与设备架构请以 GitHub Releases 的实际记录为准。

    [!IMPORTANT] 升级前请完整备份数据库、附件及部署配置,并确认备份可恢复。回滚程序或 Docker 镜像不会自动回滚持久化数据。 本次 macOS 包未做 Developer ID 签名和 Apple 公证;Windows GitHub 直接下载包也未提供代码签名。

    • AI 写作先预览再确认:编辑器助手与笔记本 Agent 支持修改建议、笔记和任务草稿;可复用自定义 Skills,管理员可授权成员使用共享模型配置。
    • 长篇 Markdown 更容易导航:新增章节折叠,搜索自动展开隐藏命中;改进 Live 图片预览和 Mermaid 兼容性。
    • 图片与附件更稳定:优化缩放、拖动、双指手势和原始分辨率预览;上传响应丢失后可恢复已保存附件,缩短稳定分享链接。
    • NAS 离线减少手动操作:桌面完整版自动准备个人笔记和受管附件副本,支持离线编辑及重连回传;加强 Android 本地优先处理。
    • 导入与界面增强:DOCX 文件大小上限提高到 1 GB;优化移动端 AI 面板、大字体卡片和并发剪藏,新增 Microsoft Store 下载入口。

    下一阶段 · v1.6.0 规划:完整工作台(Workspace)、个人应用 Studio 与插件扩展平台 V3 统一归入 v1.6.0,不属于本次 v1.5.4 的新增交付。请以实际验收与正式版本为准。

    查看 完整更新日志 · 官网版本说明 · 下载中心。

    上一正式版 v1.5.3

    v1.5.3 于 2026-10-23 公开发布,改进笔记编辑、图片管理、加密操作、日历提醒和多平台稳定性。详情见 v1.5.3 Release。

    为什么选择 Nowen Note

    数据真正属于你支持 Docker / NAS 自托管,可部署到绿联 UGOS、飞牛 fnOS 等 NAS 平台;数据库、附件、索引和备份均由你管理,附件可接入 S3、Cloudflare R2 与 MinIO,备份可同步到邮件或 WebDAV。
    一棵树管理全部内容文件夹、富文本和 Markdown 文档统一组织,根目录也能直接创建文档,支持拖拽、排序、导入、权限继承、密码保护和共享展示。
    在线与离线都能工作可缓存完整工作区、正文和附件,断网继续阅读与编辑,联网后自动恢复增量同步。
    写作、知识与行动统一笔记、每日记录、任务、AI、思维导图和协作权限在同一套产品中完成,无需在多套工具间反复切换。

    核心能力

    模块当前能力
    统一知识树文件夹、富文本与 Markdown 文档混合组织;支持根目录文档、无限层级、拖拽排序与层级调整、统一创建菜单、全部展开 / 收起、筛选搜索、数量统计、回收站和共享目录;三栏布局可展示子文件夹与层级范围。
    富文本与 MarkdownTiptap 3、CodeMirror 6、富文本 / Markdown 双编辑器与格式互转、纯文本笔记、实时预览与分屏、大纲、表格、代码块、KaTeX、Mermaid、脚注、Callout、媒体嵌入、中文排版、阅读位置恢复、批注与版本历史。
    可靠保存与离线工作区Yjs 持久化确认、按笔记作用域的同步回执、未确认修改补传、IndexedDB 草稿恢复、富文本串行版本保存;支持个人空间、共享目录和离线工作区,包含个人目录结构同步、回收站恢复及误冲突防护;离线附件支持损坏 Blob 校验与恢复。
    性能与加载工作区、编辑器、任务、日记、文件管理、AI 等功能按需加载;静态资源支持缓存验证、Gzip / Brotli 预压缩,减少首屏依赖和重复传输。
    知识组织与检索彩色标签、收藏、置顶、全文搜索、当前目录笔记搜索、文内查找替换、双向链接、块引用、反向链接、知识图谱,以及“全部笔记”固定入口。
    AI 能力OpenAI 兼容接口、通义千问、Gemini、DeepSeek、豆包与 Ollama;支持续写、改写、翻译、标题与标签生成、总结、Embedding 索引和 RAG 知识问答,并支持查询今日任务、查看完成进度以及确认后创建或完成个人任务。
    每日记录统一“瞬间 / 日历 / 日记”入口,支持短内容、心情、图片、视频、AI 周报 / 月报、自然日期命令、日记实体归档、历史目录整理和工作区共享日记。
    任务与习惯树形任务、列表、看板、日历、甘特图 / 时间轴、依赖、重复规则、提醒、模板、My Day、Inbox、离线任务 / 习惯和 Android 原生提醒;支持 AI 生成任务后确认创建、今日完成汇总、任务树归档、任务详情另存为笔记(保留原任务)、任务报表及子树导出 Excel / Markdown,并提供到期排序和 Webhook 早晚摘要。
    协作、权限与分享Yjs + WebSocket 实时协作、工作区角色、目录级 ACL、Restricted 受限模式、显式允许 / 拒绝规则、权限继承、所有权转移、分享密码与有效期、访客评论、公开知识空间,以及富文本 / Markdown 划词批注。
    导入、导出与迁移支持 Markdown、Word / DOCX、网页 URL、微信公众号、SingleFile HTML、思源、Obsidian、小米笔记等;支持选择导入为 Markdown 或富文本,并提供后台任务、进度、重试、远程图片本地化和 Markdown 图片 / 脚注导出;团队空间单篇 ZIP 会按笔记真实工作区执行权限校验。
    附件与存储文件中心提供资源管理器式文件夹导航、瀑布流、标签、智能文件夹、批量上传进度、移动 / 重命名、文件回收站及恢复、个人附件目录同步和已有附件插入;支持远程图片安全转存与逐图进度。AI 文件整理采用元数据建议、人工确认和权限校验,语义检索基于文件名 / 标签 / 描述,不读取文件字节,且受 平台与作用域限制。附件可存储于本地磁盘、S3、R2、MinIO;参见文件整理、回收站与目录同步。
    备份与恢复本地自动备份、后台完整 ZIP 任务、流式归档与校验、浏览器原生下载、邮件备份、凭据加密的 WebDAV 远程备份、Docker 在线升级前备份与失败回滚检查。
    多端访问Web、Electron(Windows / macOS / Linux)、Android、iOS 工程、HarmonyOS 工程,以及 Docker / NAS 部署;支持绿联 UGOS、飞牛 fnOS,客户端可通过 IPv4、IPv6 或域名远程连接并登录 NAS 服务;Android 支持应用内图片手势预览。
    开放能力OpenAPI 3.0、TypeScript SDK、CLI、Webhook、插件系统、受限 Personal API Token、MCP Server 和浏览器剪藏扩展;MCP 覆盖授权笔记 / 知识树、个人任务 / 项目、文件管理和个人自动化,敏感操作需要显式授权及预览确认;可选本机回环 HTTP 传输。

    AI 问答与隐私

    Nowen Note 的知识库问答采用 RAG 检索增强方式,不会在每次提问时把全部笔记内容都发送给大模型。

    • 知识库模式:先在本地索引中检索相关笔记和附件,再发送匹配到的片段。
    • 当前笔记模式:只使用当前打开的笔记。
    • 选中文本模式:只使用当前选择或粘贴的文本。
    • 本地模型:使用 Ollama 等本地服务时,可让问答内容留在自己的设备或服务器中。

    使用在线 Embedding 或在线大模型时,建立索引或回答问题所需的相关文本会发送给你自行配置的服务商。身份证、密码、API Key、助记词等高度敏感信息仍不建议以明文保存。

    让 AI 客户端连接 Nowen Note

    Nowen Note 的 MCP Server 可连接 Claude Code、Cursor、VS Code 等客户端。在 Personal API Token 授权范围内使用笔记、知识树、个人任务 / 项目、文件管理及个人自动化能力;部分新增写入工具要求先预览、明确确认,并通过并发版本校验。高风险功能默认不开放,不能绕过笔记本范围与用户权限。

    目前可通过源码构建 packages/nowen-mcp 并使用 bin/nowen-mcp.mjs 作为客户端入口(Node.js 24.22.1+(24.x LTS));dist/scoped-entry.js 仅供启动器内部加载。标准接入以 stdio 为主;v1.5.2 另提供需要明确开启、仅限本机回环地址且要求认证的 Streamable HTTP 接入。请为不同客户端创建独立、最小权限的 Token,勿在配置中写入管理员密码。

    更早版本

    v1.5.1 的任务提醒、AI 任务操作与 Android 同步修复见 v1.5.1 发布说明;历史内容见 更新日志。

    截图

    桌面端

    AI 写作助手AI 服务商配置
    桌面 AI 写作AI 设置

    移动端

    侧边栏笔记列表编辑器
    移动端侧边栏移动端列表移动端编辑器

    官网与在线体验

    演示账号仅用于体验,数据可能被定期重置。请勿存放敏感或重要内容。

    快速部署

    Docker Compose(推荐)

    要求已安装 Docker Engine 与 Docker Compose v2。

    git clone https://github.com/cropflre/nowen-note.git
    cd nowen-note
    docker compose up -d
    

    打开 http://<服务器IP>:3001。

    默认管理员账号:

    用户名:admin
    密码:admin123
    

    首次登录后请立即修改默认密码。公网部署还应配置 HTTPS、备份、正确的公开访问地址,并按需收紧 CORS。

    HTTPS 部署(可选)

    已有 Nginx、Lucky 或 NAS 反代的用户可继续复用现有入口。新部署可使用配套的 Caddy 模板自动申请和续期证书,需要 Docker Compose 2.24.4+、正确解析的公网域名及可达的 80/443 端口。

    在 .env 中设置 NOWEN_DOMAIN=note.example.com,然后执行:

    docker compose -f docker-compose.yml -f docker-compose.https.yml config --quiet
    docker compose -f docker-compose.yml -f docker-compose.https.yml up -d
    

    访问 https://note.example.com。此模板取消主应用的 3001 宿主机映射,自动设置公开分享地址,并持久化 Caddy 证书。后续管理命令也需同时指定这两个文件。

    已有实例请保持原 Compose 项目名和数据挂载,先备份再切换;HTTPS 就绪后,客户端改用域名地址。详见 HTTPS 部署与验收。

    绿联 NAS / 飞牛 NAS 远程连接登录

    Nowen Note 支持部署在 绿联 NAS(UGOS / UGOS Pro) 与 飞牛 NAS(fnOS) 上。可使用 Releases 中对应的 .upk / .fpk 安装包,也可以直接通过 Docker Compose 部署。

    部署并启动服务后:

    • 局域网访问:浏览器打开 http://<NAS局域网IP>:3001。
    • 远程访问:在 Web、桌面端或 Android 客户端中填写 NAS 的公网域名、IPv4 或 IPv6 服务地址并登录。
    • 公网使用建议配置 HTTPS 反向代理,不建议直接暴露未加密的 HTTP 服务。

    查看各平台安装包:GitHub Releases。

    查看运行状态和日志:

    docker compose ps
    docker compose logs -f --tail=200 nowen-note
    

    从旧版本升级

    升级前先在管理后台创建完整备份,并确认数据库与附件目录已经持久化。

    docker compose pull
    docker compose up -d
    

    需要固定 Docker 镜像时,请先确认目标标签已经在 Docker Hub 发布。以下使用已公开可用的 v1.5.1 标签示例(v1.5.2 镜像可用后再替换):

    NOWEN_IMAGE_TAG=v1.5.1 docker compose pull
    NOWEN_IMAGE_TAG=v1.5.1 docker compose up -d
    

    [!IMPORTANT] 升级前请先完成完整备份,确认数据库与附件已持久化。 Docker / NAS 用户建议保留独立备份;镜像回滚不会还原数据库。版本详情见 更新日志 与 公开 Releases。

    Docker 在线升级(可选)

    在线升级仅支持仓库内的官方 docker-compose.yml,且默认关闭。主应用容器不会挂载 Docker Socket;只有独立、内网隔离并受限运行的 updater 容器拥有 Docker Engine 权限。

    cp .env.example .env
    printf '\nNOWEN_UPDATER_TOKEN=%s\n' "$(openssl rand -hex 32)" >> .env
    NOWEN_IMAGE_TAG=v1.5.1 docker compose --profile updater up -d
    

    启用后,管理员可在「设置 → 关于 → 版本信息」执行升级前检查、完整备份、升级、健康验证和失败回滚。

    完整说明见 Docker 在线升级与恢复。

    仅运行主应用

    docker run -d \
      --name nowen-note \
      --restart unless-stopped \
      -p 3001:3001 \
      -e TZ=Asia/Shanghai \
      -v /opt/nowen-note/data:/app/data \
      cropflre/nowen-note:v1.5.1
    

    数据、备份与配置

    持久化目录

    容器内的持久化根目录是 /app/data,不是 /data。默认 Compose 使用名为 nowen-note-data 的 Docker Volume。

    /app/data/
    ├── nowen-note.db
    ├── attachments/
    ├── backups/
    ├── fonts/
    └── .jwt_secret
    
    • 默认生产数据库为 SQLite,主文件是 /app/data/nowen-note.db。
    • 附件默认存储在 /app/data/attachments,新文件按 YYYY/MM 分目录。
    • 自动备份默认位于 /app/data/backups。
    • 生产环境建议把 BACKUP_DIR 映射到独立物理磁盘,并遵循 3-2-1 备份原则。
    • PostgreSQL 适配和迁移仍在验证中,当前正式部署与恢复流程继续以 SQLite 为默认基线。

    常用环境变量

    完整模板见 .env.example。

    变量默认值用途
    NOWEN_PORT3001Compose 对外暴露端口
    NOWEN_DOMAIN空可选 Caddy HTTPS 模板的公网域名,仅填写主机名
    TZAsia/Shanghai容器时区,会影响任务日期与日记自然日期判断
    PUBLIC_WEB_ORIGIN空反向代理或公网域名,用于生成正确的分享链接
    FILE_PUBLIC_ORIGIN继承 PUBLIC_WEB_ORIGIN文件管理 / 图床复制直链使用的独立公网域名;上传、预览和本人下载仍走当前连接地址
    JWT_SECRET自动生成并持久化登录、会话与部分加密回退;多实例部署时必须统一配置
    BACKUP_DIR/app/data/backups自动备份目录
    BACKUP_WEBDAV_ENCRYPTION_KEY回退到 JWT_SECRET加密保存 WebDAV 凭据,生产环境建议单独配置
    CORS_ORIGINS内置原生客户端来源额外允许的网页 Origin,逗号分隔
    MAX_ATTACHMENT_SIZE_MB100单个附件大小上限
    ATTACHMENT_STORAGElocal设为 s3 后可接入 S3 / R2 / MinIO
    NOWEN_UPDATER_TOKEN空启用 Docker 在线升级代理

    客户端与平台状态

    平台获取 / 构建方式状态说明
    Web / DockerDocker Hub 或源码构建推荐部署方式;镜像可构建 amd64、arm64 或多架构版本
    Windows / macOS / LinuxGitHub Releases 或 npm run electron:buildElectron 客户端可连接远程服务,也可使用本地后端
    AndroidReleases APK 或在 frontend/ 下使用 Capacitor 构建正式维护;支持系统分享导入、Markdown 导入、沉浸式编辑、移动端知识树、图片手势预览、系统原生任务提醒,以及远程连接 NAS 服务登录
    iOSCapacitor 工程与 GitHub Actions / TestFlight 流程需要 Apple 签名与开发者账号,详见 iOS 发布指南
    HarmonyOS使用 DevEco Studio 打开 nowen-harmony/ArkTS + ArkWeb MVP;部分原生能力仍在完善
    fnOSReleases 中的 .fpk支持飞牛 NAS 安装;当前 .fpk 主要面向 x86_64,部署后可通过局域网或公网地址远程连接登录
    绿联 UGOSReleases / 构建脚本中的 .upk支持绿联 NAS 安装,依赖具体设备架构与应用安装能力;部署后可通过局域网或公网地址远程连接登录
    其他 NASDocker Compose群晖、威联通、极空间等可按 Docker 方式部署

    各平台实际发布的安装包以 GitHub Releases 为准。

    桌面端最低要求 macOS 12(Monterey);macOS 11 用户不会收到该版本的自动更新。完整升级说明见 Node 24 迁移说明。

    本地开发

    要求 Node.js 24.22.1+(24.x LTS)、npm、Git。Electron 和原生依赖构建还需要对应平台的编译工具链。

    git clone https://github.com/cropflre/nowen-note.git
    cd nowen-note
    npm install
    npm run install:all
    npm run dev
    

    也可以分别启动:

    npm run dev:backend
    npm run dev:frontend
    

    访问 http://localhost:5173。

    常用命令:

    npm run build:all                 # 构建前端与后端
    npm run electron:dev              # Electron 开发
    npm run electron:build            # Electron 打包
    (cd backend && npm test)          # 后端测试
    (cd frontend && npm run test:run) # 前端测试
    

    Android:

    cd frontend
    npm run cap:build
    npx cap open android
    

    Web、Electron 和移动端构建统一使用 Node.js 24.22.1(24.x LTS);运行 nvm install && nvm use 可切换到项目版本。

    iOS:

    npm run cap:sync:ios
    npm run cap:open:ios
    

    技术架构

    层主要技术
    前端React 19、TypeScript、Vite 5、Tailwind CSS、Tiptap 3、CodeMirror 6、Yjs、IndexedDB
    后端Node.js 24 LTS、Hono 4、WebSocket、better-sqlite3、FTS5、sqlite-vec、sharp
    桌面端Electron 43、electron-builder、electron-updater
    移动端Capacitor 8(Android / iOS)、ArkTS + ArkWeb(HarmonyOS)
    存储与备份SQLite、本地附件、S3 / Cloudflare R2 / MinIO、邮件与 WebDAV;PostgreSQL 处于适配验证阶段
    开放能力OpenAPI 3.0、TypeScript SDK、CLI、MCP Server、Webhook

    项目结构

    nowen-note/
    ├── frontend/       # React Web 与 Capacitor 客户端
    ├── backend/        # Hono API、数据库、同步与后台任务
    ├── electron/       # Electron 主进程与打包配置
    ├── packages/       # SDK、CLI、MCP 等开发者包
    ├── nowen-harmony/  # HarmonyOS ArkTS / ArkWeb 客户端
    ├── docs/           # 部署、教程与设计文档
    └── scripts/        # 构建、迁移、打包与发布脚本
    

    AI Skills:让 AI 理解和操作 Nowen Note

    仓库提供两种用途不同的 Agent Skills。Skill 是 AI 助手的工作指引,不是自动连接服务器的插件,也不包含任何私人笔记或 API 密钥。

    • nowen-note-development:面向项目维护者和 AI 编码助手。包含项目定位、模块导航、Issue/PR 分析、UI 设计原则、同步/权限/备份安全边界、开发测试和交付验收规范。
    • nowen-note:面向知识库使用者。指导 AI 在授权范围内搜索、读取、创建和整理笔记,通过 MCP(优先)或已配置的 CLI 操作。

    仓库同时提供 .claude/skills/ 镜像,便于支持该目录的客户端使用。将对应 Skill 放到 AI 客户端支持的 Skills 目录,或让编码助手先阅读对应 SKILL.md;不同客户端的自动发现规则以其文档为准。

    如需 AI 实际读取或写入你的笔记,还需按 MCP 安装教程 连接 Nowen Note,并创建限制笔记本和操作范围的 Personal API Token;仅安装 Skill 不会赋予数据权限。

    示例:让 AI “先阅读 nowen-note-development Skill,分析 Issue 对应代码、实现最小修复并列出验证结果”。

    文档导航

    当前边界

    • 数据库:SQLite 是当前默认且完整支持的生产方案;PostgreSQL 已有适配器、Schema 和部分双库测试,但尚未开放正式切换。
    • 格式互转:Markdown 与富文本互转会尽量保留主要结构,但高度定制的 HTML、复杂扩展节点或第三方语法仍可能需要人工检查。
    • AI 隐私:使用在线 Embedding 或在线大模型时,相关文本会发送到用户自行配置的服务商;敏感信息建议使用本地模型或不要存储。
    • WebDAV:用于上传已经完成的备份文件,不是实时同步、数据库运行目录或附件在线存储后端。
    • Docker 在线升级:只支持官方 Compose 受管部署,不支持任意容器、任意镜像或 NAS 应用包。
    • macOS:安装包若未经过 Apple 公证,首次打开可能需要执行 xattr 解除隔离,详见 桌面端教程。
    • 移动端:Android 维护最完整;iOS 与 HarmonyOS 的分发、签名和部分原生桥接能力仍受平台工具链限制。
    • 快速迭代:功能和安装包更新较快,请以 Releases、应用内版本信息和 CHANGELOG.md 为准。

    版本与更新

    README 维护稳定的产品定位、能力范围、近期版本和部署方式;完整提交历史请查看更新日志。

    参与贡献

    欢迎提交 Issue、功能建议和 Pull Request。提交代码前建议至少完成:

    npm run build:all
    (cd backend && npm test)
    (cd frontend && npm run test:run)
    

    反馈入口:

    支持作者

    如果 Nowen Note 对你有帮助,欢迎扫码请作者喝杯咖啡。感谢每一份支持,它会帮助项目持续维护和迭代。

    也可以阅读 作者感言。

    License

    Nowen Note 基于 GNU General Public License v3.0 开源。