自托管私有知识库，对标群晖 Note Station。

A self-hosted private knowledge base, inspired by Synology Note Station.

nowen-note 是一款自托管的私有化知识管理应用，采用现代前后端分离架构，支持 Docker 一键部署、Electron 桌面客户端、Android 移动端（Capacitor）。集成 Tiptap 富文本编辑器、AI 智能写作助手（支持 6 大 AI 服务商 + 本地 Ollama）、思维导图、任务管理中心、FTS5 全文搜索、笔记分享协作（密码保护/有效期/评论批注）、版本历史回溯、批处理管道（AI 增强）、插件系统、Webhook 事件推送、审计日志、数据备份恢复、多平台数据导入（小米/OPPO/iCloud）、数据导出等功能，打造一体化知识管理平台。同时提供 MCP Server（22 个 AI 工具）、TypeScript SDK 和命令行工具（CLI），构建完整的开发者生态系统。

nowen-note/
├── frontend/              # 前端 React 应用
│   ├── src/
│   │   ├── components/    # 组件（28 个）
│   │   │   ├── Sidebar.tsx            # 侧边栏（笔记本树 + 导航 + 标签）
│   │   │   ├── NoteList.tsx           # 笔记列表（多视图 + 右键菜单）
│   │   │   ├── EditorPane.tsx         # 编辑器面板（AI 标题/标签 + 大纲 + 锁定 + 分享 + 版本历史）
│   │   │   ├── TiptapEditor.tsx       # Tiptap 富文本编辑器
│   │   │   ├── AIChatPanel.tsx        # AI 知识库问答面板（RAG + Markdown 渲染）
│   │   │   ├── AIWritingAssistant.tsx # AI 写作助手（10 种文本操作）
│   │   │   ├── AISettingsPanel.tsx    # AI 服务配置（6 大 Provider 卡片）
│   │   │   ├── TaskCenter.tsx         # 任务管理中心
│   │   │   ├── MindMapEditor.tsx      # 思维导图编辑器
│   │   │   ├── DiaryCenter.tsx        # 说说/动态（微博风格时间线）
│   │   │   ├── CodexPanel.tsx         # 批处理管道面板（Codex 可视化流水线）
│   │   │   ├── ShareModal.tsx         # 分享弹窗（链接生成 + 密码 + 有效期 + 权限）
│   │   │   ├── SharedNoteView.tsx     # 公开分享笔记查看页
│   │   │   ├── CommentPanel.tsx       # 评论批注面板（行内锚点 + 回复 + 解决）
│   │   │   ├── VersionHistoryPanel.tsx # 版本历史面板（版本对比 + 回滚）
│   │   │   ├── TagColorPicker.tsx     # 标签颜色选择器
│   │   │   ├── LoginPage.tsx          # 登录页
│   │   │   ├── ServerConnect.tsx      # 服务器连接配置（客户端模式）
│   │   │   ├── ContextMenu.tsx        # 通用右键菜单组件
│   │   │   ├── SettingsModal.tsx      # 设置中心（外观/AI/安全/数据）
│   │   │   ├── SecuritySettings.tsx   # 账号安全设置
│   │   │   ├── DataManager.tsx        # 数据管理（导入导出 + 恢复出厂）
│   │   │   ├── MiCloudImport.tsx      # 小米云笔记导入
│   │   │   ├── OppoCloudImport.tsx    # OPPO 云便签导入
│   │   │   ├── iCloudImport.tsx       # iPhone/iCloud 备忘录导入
│   │   │   ├── TagInput.tsx           # 标签输入组件
│   │   │   ├── ThemeProvider.tsx      # 主题 Provider
│   │   │   └── ThemeToggle.tsx        # 主题切换
│   │   ├── hooks/         # 自定义 Hooks
│   │   │   ├── useContextMenu.ts      # 右键菜单状态管理 + 边缘碰撞检测
│   │   │   ├── useCapacitor.ts        # Capacitor 移动端能力（返回键/状态栏/触觉反馈）
│   │   │   └── useSiteSettings.tsx    # 站点设置 Context（标题/图标/字体）
│   │   ├── store/         # 状态管理（useReducer + Context）
│   │   ├── lib/           # 工具函数 & API 封装
│   │   │   ├── api.ts              # API 客户端（含 AI 流式接口）
│   │   │   ├── exportService.ts    # 导出服务
│   │   │   ├── importService.ts    # 导入服务
│   │   │   └── miNoteService.ts    # 小米云笔记服务封装
│   │   ├── i18n/          # 国际化配置 & 语言包（中/英）
│   │   └── types/         # 类型定义
│   ├── capacitor.config.ts # Capacitor 移动端配置
│   └── android/           # Android 原生壳
├── backend/               # 后端 Hono 应用
│   └── src/
│       ├── db/            # 数据库 Schema & 迁移（16 张表 + FTS5）
│       ├── routes/        # API 路由（21 个模块）
│       │   ├── auth.ts        # 认证（登录/改密/恢复出厂）
│       │   ├── notebooks.ts   # 笔记本 CRUD（无限层级）
│       │   ├── notes.ts       # 笔记 CRUD（锁定/置顶/收藏 + Webhook/审计集成）
│       │   ├── tags.ts        # 标签管理
│       │   ├── tasks.ts       # 待办任务（子任务/优先级/截止日期）
│       │   ├── mindmaps.ts    # 思维导图 CRUD
│       │   ├── diary.ts       # 说说/动态（时间线 + 发布/删除/统计）
│       │   ├── ai.ts          # AI 聊天 + 写作助手 + RAG 知识问答
│       │   ├── search.ts      # FTS5 全文搜索
│       │   ├── export.ts      # 数据导入导出
│       │   ├── shares.ts      # 笔记分享（链接/密码/权限/评论/版本历史）
│       │   ├── pipelines.ts   # 批处理管道引擎（5 种步骤类型）
│       │   ├── plugins.ts     # 插件管理与执行
│       │   ├── webhooks.ts    # Webhook 管理（CRUD + 测试 + 投递日志）
│       │   ├── audit.ts       # 审计日志（查询/统计/清理）
│       │   ├── backups.ts     # 数据备份与恢复
│       │   ├── settings.ts    # 站点配置（标题/图标/字体）
│       │   ├── fonts.ts       # 自定义字体管理（上传/下载/删除）
│       │   ├── micloud.ts     # 小米云笔记导入 API
│       │   ├── oppocloud.ts   # OPPO 云便签导入 API
│       │   └── icloud.ts      # iPhone/iCloud 备忘录导入 API
│       ├── services/      # 服务层
│       │   ├── webhook.ts     # Webhook 事件分发（HMAC-SHA256 签名 + 重试）
│       │   ├── audit.ts       # 审计日志记录器
│       │   ├── backup.ts      # 备份管理器（全量/增量 + 自动定时）
│       │   └── openapi.ts     # OpenAPI 3.0 规范生成
│       ├── plugins/       # 插件系统
│       │   └── plugin-loader.ts  # 插件加载器（热加载 + 沙箱执行）
│       └── index.ts       # 入口文件（JWT 中间件 + 速率限制 + 路由注册 + 静态文件托管）
├── packages/              # 开发者工具包
│   ├── nowen-mcp/         # MCP Server（22 个 AI 工具 + 资源）
│   │   └── src/
│   │       ├── index.ts       # MCP 工具注册
│   │       └── api-client.ts  # API 客户端
│   ├── nowen-sdk/         # TypeScript SDK（60+ API 方法）
│   │   └── src/
│   │       ├── client.ts      # NowenClient 完整 API
│   │       ├── types.ts       # 类型定义
│   │       └── index.ts       # 导出入口
│   └── nowen-cli/         # 命令行工具（8 组命令）
│       └── src/
│           ├── cli.ts         # CLI 入口 + Commander 注册
│           └── commands/      # 命令模块
│               ├── notes.ts       # 笔记命令
│               ├── notebooks.ts   # 笔记本命令
│               ├── tags.ts        # 标签命令
│               ├── tasks.ts       # 任务命令
│               ├── search.ts      # 搜索命令
│               ├── ai.ts          # AI 命令
│               ├── pipelines.ts   # 管道命令
│               └── config.ts      # 配置命令
├── electron/              # Electron 桌面端
│   ├── main.js            # 主进程（fork 后端 + 创建窗口）
│   ├── builder.config.js  # electron-builder 打包配置
│   └── icon.png           # 应用图标
├── Dockerfile             # 多阶段构建（3 阶段）
├── docker-compose.yml     # 容器编排（单服务 + 持久化卷）
└── package.json           # 根级脚本

默认管理员账号：admin / admin123

首次登录后请立即在「设置 → 账号安全」中修改密码。

环境要求： Node.js 20+、Git

# 1. 克隆项目
git clone https://github.com/cropflre/nowen-note.git
cd nowen-note

# 2. 安装所有依赖
npm run install:all

# 3. 启动后端（端口 3001）
npm run dev:backend

# 4. 新开一个终端，启动前端（端口 5173，自动代理 /api → 3001）
npm run dev:frontend

浏览器访问 http://localhost:5173 即可使用。

数据库文件位于 backend/data/nowen-note.db，备份此文件即可迁移数据。

适用于任何安装了 Docker 的 Linux / macOS / Windows 设备。

方法 A：docker-compose（推荐）

# 1. 克隆项目
git clone https://github.com/cropflre/nowen-note.git
cd nowen-note

# 2. 一键构建并启动
docker-compose up -d

方法 B：纯 docker 命令（仅主应用）

# 1. 克隆并构建镜像
git clone https://github.com/cropflre/nowen-note.git
cd nowen-note
docker build -t nowen-note .

# 2. 创建数据目录并运行
mkdir -p /opt/nowen-note/data
docker run -d \
  --name nowen-note \
  --restart unless-stopped \
  -p 3001:3001 \
  -v /opt/nowen-note/data:/app/data \
  -e DB_PATH=/app/data/nowen-note.db \
  nowen-note

浏览器访问 http://<你的IP>:3001 即可使用。

服务端口：

环境变量说明：

支持 Windows（NSIS 安装程序）、macOS（DMG）、Linux（AppImage）。

# 开发运行
npm run electron:dev

# 打包发布
npm run electron:build

打包产物输出到 release/ 目录。桌面端自动 fork 后端进程，数据库存储在用户目录 nowen-data/ 下。

基于 Capacitor 8 构建 Android 原生应用，连接远程服务器使用。

方法 A：使用预编译 APK（推荐）

直接从 GitHub Releases 下载最新的 APK 安装包，传输到手机安装即可。

方法 B：自行编译

# 1. 构建前端
npm run build:frontend

# 2. 同步到 Android 项目
npx cap sync android

# 3. 用 Android Studio 打开并构建
npx cap open android

# 或直接命令行打包 Release APK（需配置签名）
cd frontend/android
./gradlew assembleRelease

签名配置： 如需构建 Release 版本，请在 frontend/android/ 目录下创建 keystore.properties 文件：

storePassword=你的密码
keyPassword=你的密码
keyAlias=你的别名
storeFile=你的keystore路径

移动端首次启动需配置服务器地址（IP:端口 或域名），通过 HTTP 连接到已部署的 nowen-note 后端。

Android 图标： 自定义设计的 Nowen Note 品牌图标，深色背景（#0D1117）+ 白色笔记纸 + 蓝色品牌字母 N + 铅笔装饰，支持 Android 自适应图标（Adaptive Icon）。

前提： 已安装 Container Manager（DSM 7.2+）或 Docker 套件（DSM 7.0 / 7.1）。

步骤：

1. 上传镜像

   • 在电脑上执行 docker build -t nowen-note . 构建镜像
   • 导出镜像：docker save nowen-note -o nowen-note.tar
   • 在群晖 Container Manager → 映像 → 导入 → 上传 nowen-note.tar

2. 创建容器

   • 映像列表中选择 nowen-note → 启动
   • 端口设置：本地端口 3001 → 容器端口 3001
   • 存储空间：新增文件夹映射
     • 本地路径：/docker/nowen-note/data
     • 容器路径：/app/data
   • 环境变量（默认即可，无需修改）

3. 访问使用

   • 浏览器访问 http://<群晖IP>:3001

提示： 数据备份只需复制 /docker/nowen-note/data/nowen-note.db 文件。可使用群晖 Hyper Backup 定期备份该目录。也可通过 API /api/backups 进行在线备份管理。

前提： 已开启 Docker 功能（绿联 UGOS Pro / UGOS）。

步骤：

1. 导入镜像

   • 在电脑上构建并导出镜像（同群晖步骤）
   • 绿联 NAS → Docker → 镜像管理 → 本地导入 nowen-note.tar

2. 创建容器

   • 选择 nowen-note 镜像 → 创建容器
   • 网络：选择 bridge 模式
   • 端口映射：主机 3001 → 容器 3001
   • 存储映射：
     • 主机路径：/mnt/user/appdata/nowen-note/data（或自定义路径）
     • 容器路径：/app/data
   • 重启策略：开机自启

3. 访问使用

   • 浏览器访问 http://<绿联NAS IP>:3001

前提： 飞牛 fnOS 已开启 Docker 功能。

步骤：

1. 导入镜像

   • 在电脑上构建并导出镜像（同群晖步骤）
   • 飞牛 fnOS → Docker → 镜像 → 导入 nowen-note.tar

2. 创建容器

   • 选择 nowen-note 镜像 → 创建容器
   • 端口映射：主机 3001 → 容器 3001
   • 卷映射：
     • 主机路径：/vol1/docker/nowen-note/data（根据实际存储卷调整）
     • 容器路径：/app/data
   • 重启策略：除非手动停止

3. 访问使用

   • 浏览器访问 http://<飞牛NAS IP>:3001

前提： 已安装 Container Station（QTS 5.0+ / QuTS hero）。

步骤：

1. 导入镜像

   • 在电脑上构建并导出镜像（同群晖步骤）
   • Container Station → 映像档 → 导入 → 选择 nowen-note.tar

2. 创建容器

   • 选择 nowen-note 映像 → 创建
   • 网络设置：NAT 模式，端口映射 3001 → 3001
   • 共享文件夹：
     • 主机路径：/share/Container/nowen-note/data
     • 容器路径：/app/data
   • 其他：勾选"自动重新启动"

3. 访问使用

   • 浏览器访问 http://<威联通IP>:3001

提示： QNAP 也支持 docker-compose，在 Container Station → 创建 → 使用 YAML 创建，粘贴本项目的 docker-compose.yml 内容即可。

前提： 极空间 ZOS 已开启 Docker 功能（极空间 Z4S / Z4 Pro / Z2 Pro 等）。

步骤：

1. 导入镜像

   • 在电脑上构建并导出镜像（同群晖步骤）
   • 极空间 → Docker → 镜像 → 本地镜像 → 导入 nowen-note.tar

2. 创建容器

   • 选择 nowen-note 镜像 → 创建容器
   • 端口映射：本地 3001 → 容器 3001
   • 路径映射：
     • 本地路径：选择一个文件夹（如 极空间/docker/nowen-note/data）
     • 容器路径：/app/data
   • 重启策略：自动重启

3. 访问使用

   • 浏览器访问 http://<极空间IP>:3001

• 数据持久化：务必将容器内的 /app/data 目录映射到宿主机，否则容器删除后数据丢失
• 数据备份：支持两种方式 — 直接备份 nowen-note.db 文件，或通过 API /api/backups 在线创建/下载备份
• 自动备份：服务启动后自动开启每 24 小时数据库备份，保留最近 10 个自动备份
• 端口冲突：如 3001 端口被占用，可修改主机端口映射（如 8080:3001）
• 安全建议：首次登录后请立即修改默认密码；如需外网访问，建议搭配反向代理（Nginx / Caddy）并启用 HTTPS
• Ollama：如需本地 AI 推理，请自行部署 Ollama 服务并配置 OLLAMA_URL 环境变量

• JWT Token 认证（30 天有效期）
• 登录页面（带动画与默认账号提示）
• 修改用户名 / 密码（需验证当前密码）
• SHA256 → bcrypt 密码哈希自动升级
• 客户端模式支持服务器地址配置（Electron / Android / file:// 协议）

• 三栏布局：侧边栏 + 笔记列表 + 编辑器（均支持拖拽调整宽度，双击恢复默认）
• Tiptap 富文本编辑器：Markdown 快捷键、代码高亮、图片插入、任务列表
• 笔记操作：置顶、收藏、锁定（前后端双层保护）、软删除（回收站）、恢复、永久删除
• 笔记移动：右键菜单"移动到..."弹窗（树形笔记本选择器）、编辑器顶栏快速切换笔记本
• 字数统计：实时显示词数和字符数（中文按字计数，英文按空格分词）
• 笔记大纲：自动提取 H1-H3 标题生成大纲面板，点击标题跳转定位
• 日历筛选：笔记列表标题栏日历按钮，选择日期后按更新时间筛选笔记
• 乐观锁：version 字段防止编辑冲突
• 快捷键：Alt+N 快速新建笔记

• 支持无限层级嵌套（树形结构）
• 右键菜单：新建笔记、新建子笔记本、更换图标、重命名、删除
• 行内重命名：原地 <input> 编辑，Enter 保存、Escape 取消
• 自定义图标：点击笔记本图标或右键「更换图标」弹出 Emoji 选择器（5 分类：物品/表情/科技/自然/食物）

• AI 写作助手：选中文本后触发，支持 10 种操作
  • 续写、重写、润色、缩写、扩写
  • 中英互译、总结、解释、语法修正
  • 支持「替换选中」或「插入到光标后」两种应用方式
• AI 生成标题：基于笔记内容一键生成标题
• AI 推荐标签：智能推荐标签并自动创建、关联
• AI 知识问答（RAG）：
  • 基于 FTS5 + LIKE 模糊检索知识库相关笔记
  • 将检索到的笔记片段作为上下文组装 RAG 提示词
  • SSE 流式输出，Markdown 格式化渲染
  • 支持多轮对话（自动携带最近 6 条历史消息）
  • 显示参考笔记来源标签
• 多 AI 服务商支持：

• 卡片式 Provider 选择：渐变色图标、配置状态指示、自动填充 URL 和模型
• 连接测试 & 模型列表拉取：实时验证配置可用性

• 链接分享：一键生成分享链接，支持复制短链接
• 密码保护：可选设置访问密码，前端密码验证页面
• 有效期控制：支持 1 小时 / 1 天 / 7 天 / 30 天 / 永久
• 最大访问次数：可限制分享链接的查看次数
• 权限管理：只读 / 可评论两种权限模式
• 评论批注：支持行内锚点批注、回复、标记已解决
• 分享管理：查看所有分享链接、访问统计、一键禁用/删除
• 安全防护：速率限制（每分钟 60 次访问 + 密码验证每分钟 10 次）、安全响应头

• 自动记录：笔记每次保存自动创建版本快照
• 版本列表：按时间倒序展示所有历史版本
• 版本对比：查看任意版本的标题和内容
• 版本回滚：一键恢复到历史版本
• 变更摘要：自动记录变更类型（编辑/创建/回滚）

• 可视化脑图编辑器，自研树形布局算法
• 节点操作：新增子节点、编辑、删除、折叠/展开
• 支持键盘快捷键（Tab/Enter/Delete/Space）
• 小地图导航，缩放平移，触摸手势
• 右键导出：PNG（2x 高清）、SVG、.xmind 格式
• 移动端适配：长按编辑节点、长按列表项触发导出菜单、响应式布局

• 任务中心：独立任务管理面板，桌面端三栏布局（筛选面板 + 列表 + 详情）
• 优先级：高 / 中 / 低三级优先级
• 截止日期：日期选择，智能显示（今天/明天/本周/已逾期）
• 子任务：父子关系任务拆分
• 多维筛选：全部 / 今天 / 本周 / 逾期 / 已完成
• 任务统计：完成率、逾期数等摘要
• 移动端适配：水平滚动筛选标签、任务详情全屏覆盖、触摸友好的删除按钮

• 微博风格时间线：一句话快速发布，轻量便捷
• 发布框：文字输入 + 心情选择（12 种）+ Ctrl+Enter 快捷发布
• 动态卡片：内容 + 心情 emoji + 相对时间显示 + 删除（二次确认）
• 时间线分组：按日期自动分组（今天/昨天/具体日期），游标分页加载更多
• 统计概览：总动态数 + 今日发布数

• 可视化流水线编辑器：拖拽式步骤排列，实时预览执行结果
• 5 种步骤类型：
  • AI 摘要 — 自动为笔记生成摘要
  • AI 翻译 — 批量翻译笔记内容
  • AI 标签 — 智能推荐并关联标签
  • 内容格式化 — 自动优化排版
  • 导出 — 批量导出为 Markdown/HTML/JSON
• 内置管道模板：预置常用管道（周报生成、知识整理、翻译管线等）
• 批量选择笔记：支持多选笔记作为管道输入
• 执行进度：实时展示每个步骤的执行状态和结果

• 热加载：自动扫描 data/plugins/ 目录加载插件
• 沙箱执行：隔离运行插件代码，防止系统影响
• 标准化接口：插件声明 manifest.json（名称/版本/能力）
• 能力注册：note-processor（笔记处理）、exporter（导出器）等
• API 管理：列出插件 / 重新加载 / 执行指定插件

• 12 种事件类型：
  • note.created / note.updated / note.deleted / note.trashed
  • notebook.created / notebook.deleted
  • tag.created
  • task.created / task.completed
  • pipeline.completed
  • plugin.executed
  • *（通配：接收所有事件）
• HMAC-SHA256 签名：X-Nowen-Signature 请求头，防止伪造
• 自动重试：最多 3 次，指数退避（1s → 2s → 4s）
• 10 秒超时：防止回调卡住
• 投递日志：完整记录每次推送的状态码、响应体、尝试次数
• 测试发送：一键发送测试事件验证 Webhook 配置

• 10 大分类：auth / note / notebook / tag / task / share / ai / pipeline / plugin / system
• 3 个级别：info / warn / error
• 自动记录：笔记创建/删除等关键操作自动写入审计日志
• 多维查询：按用户/分类/级别/目标/日期范围/分页查询
• 统计看板：总记录数、今日操作数、按分类/级别统计
• 自动清理：支持配置保留天数（默认 90 天），定期清理过期日志

• 两种备份模式：
  • db-only — 仅备份数据库文件（SQLite 在线备份）
  • full — 全量备份（JSON 导出所有表数据）
• 自动备份：服务启动后每 24 小时自动创建数据库备份，保留最近 10 个
• SHA256 校验：每个备份文件自动生成校验和
• 在线下载：通过 API 直接下载备份文件
• 一键恢复：从全量备份事务恢复，显示每张表恢复的行数
• 备份管理：列出 / 创建 / 下载 / 删除备份

• 基于 SQLite FTS5 虚拟表
• 通过触发器自动同步索引（INSERT/UPDATE/DELETE）
• 搜索 title + contentText

• 多对多关系，彩色标签
• 侧边栏标签面板快速筛选

• 通用右键菜单组件（毛玻璃面板 + 动画出入场）
• 四方向边缘碰撞检测（菜单不会溢出屏幕，8px 安全边距）
• 支持分隔线、危险操作高亮、禁用状态
• 笔记本列表 & 笔记列表均支持右键操作

• 导出备份：全量导出为 ZIP 压缩包（Markdown + YAML frontmatter），含进度条
• 导入笔记：支持拖拽上传 .md / .txt / .html / .zip 文件，可选择目标笔记本
• 小米云笔记导入：通过 Cookie 认证连接小米云服务，自动获取笔记列表并批量导入
• OPPO 云便签导入：提供浏览器控制台提取脚本（OPPO 便签内容 AES 加密，仅页面端解密），一键复制脚本 → 粘贴 JSON → 选择导入
• iPhone/iCloud 备忘录导入：提供两种导入方式
  • 方式一：通过 Mac/iPhone 直接导出为 .txt / .md / .html 文件后导入（推荐）
  • 方式二：通过 iCloud 网页端控制台脚本自动提取，支持自动逐条点击 → 提取内容 → 复制到剪贴板 → 粘贴 JSON → 选择导入。自动转换 Apple Notes Checklist 为 Tiptap taskList 格式
• 恢复出厂设置：清空所有数据并重置管理员账户，二次确认防误触（需输入 RESET）

• 外观设置：主题切换（浅色 / 深色 / 跟随系统）、站点名称与图标自定义
• 字体管理：内置 4 种字体方案（默认 / 系统 / 衬线 / 等宽）+ 自定义字体上传（支持 otf/ttf/otc/ttc/woff/woff2，支持批量），实时预览
• AI 设置：AI 服务商配置、连接测试、模型管理
• 账号安全：修改用户名和密码
• 数据管理：导入导出与恢复出厂

• 深色 / 浅色 / 跟随系统三种主题模式
• 侧边栏可折叠（仅图标模式）
• 国际化支持：中英文双语切换
• Framer Motion 丝滑动画
• 全局快捷键：Alt+N 快速新建笔记
• 移动端全面适配：
  • 抽屉式侧边栏（滑动手势开关）+ 列表/编辑器双视图切换
  • TaskCenter 响应式三栏 → 移动端水平筛选标签 + 全屏详情
  • SettingsModal 移动端全屏 + 顶部标签栏切换
  • EditorPane 移动端「更多操作」菜单（删除/移动/AI/大纲）
  • 触摸友好：所有 hover 交互按钮在移动端始终可见
  • ContextMenu 四方向边界碰撞检测
  • 编辑器元信息自动折行、MoveNoteModal 自适应宽度
  • 日历筛选移动端入口、MindMap 列表长按导出
  • safe-area-inset 安全区域适配（刘海屏 / 底部手势条）

• Web 端：浏览器直接访问，响应式布局适配桌面和移动端
• Electron 桌面端：Windows（NSIS）/ macOS（DMG）/ Linux（AppImage），自动管理后端进程，数据存储在用户目录
• Android 移动端：基于 Capacitor 构建原生应用，自定义品牌图标，支持 Release 签名打包，连接远程服务器使用
• 客户端模式：Electron 和 Android 端支持配置服务器地址，通过 HTTP 连接到已部署的后端

为 AI 助手（Claude、Cursor、Windsurf 等）提供 22 个可调用的工具和资源，实现 AI 直接操作笔记系统。

安装与配置：

{
  "mcpServers": {
    "nowen-note": {
      "command": "npx",
      "args": ["tsx", "packages/nowen-mcp/src/index.ts"],
      "env": {
        "NOWEN_API_URL": "http://localhost:3001",
        "NOWEN_TOKEN": "你的JWT Token"
      }
    }
  }
}

工具列表（22 个）：

提供 60+ 类型安全的 API 方法，完整覆盖所有后端能力。

安装：

npm install @nowen/sdk

使用示例：

import { NowenClient } from "@nowen/sdk";

const client = new NowenClient({
  baseUrl: "http://localhost:3001",
  token: "your-jwt-token",
});

// 获取笔记列表
const notes = await client.listNotes({ notebookId: "xxx" });

// 创建笔记
const note = await client.createNote({
  notebookId: "xxx",
  title: "新笔记",
  content: "...",
});

// AI 知识问答
const answer = await client.askAI("项目有哪些新功能？");

// 创建 Webhook
const webhook = await client.createWebhook({
  url: "https://your-server.com/hook",
  events: ["note.created", "note.updated"],
});

// 创建备份
const backup = await client.createBackup("full");

API 分组：

终端中管理笔记系统，支持 8 组命令。

安装与配置：

# 安装依赖
cd packages/nowen-cli && npm install

# 配置服务器
npx nowen config set-url http://localhost:3001
npx nowen config set-token <your-jwt-token>

# 查看配置
npx nowen config show

命令列表：

# 笔记操作
nowen notes list [--notebook <id>]        # 列出笔记
nowen notes get <id>                       # 查看笔记
nowen notes create --notebook <id> --title "标题"  # 创建笔记
nowen notes update <id> --title "新标题"   # 更新笔记
nowen notes delete <id>                    # 删除笔记
nowen notes search <关键词>                # 搜索笔记

# 笔记本操作
nowen notebooks list                       # 列出笔记本
nowen notebooks create --name "名称"       # 创建笔记本

# 标签操作
nowen tags list                            # 列出标签
nowen tags create --name "标签名"          # 创建标签

# 任务操作
nowen tasks list [--status <状态>]         # 列出任务
nowen tasks create --title "任务名"        # 创建任务
nowen tasks toggle <id>                    # 切换完成状态

# 搜索
nowen search <关键词>                      # 全文搜索

# AI
nowen ai ask "你的问题"                    # 知识库问答
nowen ai chat "对话内容"                   # AI 对话

# 管道
nowen pipelines list                       # 列出管道
nowen pipelines run <id> --notes <id1,id2> # 执行管道

# 配置
nowen config show                          # 显示配置
nowen config set-url <url>                 # 设置服务器地址
nowen config set-token <token>             # 设置 JWT Token

提供完整的 OpenAPI 3.0 规范文档，可供 Swagger UI、Postman 等工具消费。

GET http://localhost:3001/api/openapi.json

覆盖 16 个 API 分组、50+ 端点，包含完整的请求/响应 Schema 定义。

┌───────────────────────────────────────────┐
│              Docker Compose                │
│                                           │
│  ┌─────────────────────────────────────┐  │
│  │           nowen-note :3001          │  │
│  │                                     │  │
│  │  ┌─────────────┐                    │  │
│  │  │  Frontend   │                    │  │
│  │  │  React      │                    │  │
│  │  │  Tiptap     │                    │  │
│  │  ├─────────────┤                    │  │
│  │  │  Backend    │                    │  │
│  │  │  Hono       │◄──► 外部 AI API:   │  │
│  │  │  SQLite     │     通义千问       │  │
│  │  │  JWT        │     OpenAI/Gemini  │  │
│  │  │             │     DeepSeek/豆包   │  │
│  │  └─────────────┘     Ollama（可选）  │  │
│  └─────────────────────────────────────┘  │
└───────────────────────────────────────────┘

16 张数据表 + 1 张 FTS5 全文搜索虚拟表：

nowen-note is a self-hosted private knowledge management application with a modern frontend-backend separated architecture. It supports one-click Docker deployment, Electron desktop client, and Android mobile app (Capacitor). Featuring a Tiptap rich-text editor, AI-powered writing assistant (supporting 6 major AI providers + local Ollama), mind mapping, task management, moments/status updates, FTS5 full-text search, note sharing & collaboration (password protection / expiry / comments), version history, batch processing pipelines (AI-enhanced), plugin system, Webhook event notifications, audit logging, data backup & restore, multi-platform data import (Xiaomi / OPPO / iCloud), data export, and more — an all-in-one knowledge management platform. It also provides an MCP Server (22 AI tools), TypeScript SDK, and CLI, forming a complete developer ecosystem.

Default admin credentials: admin / admin123

Please change the password immediately after first login via Settings → Account Security.

Requirements: Node.js 20+, Git

# 1. Clone the project
git clone https://github.com/cropflre/nowen-note.git
cd nowen-note

# 2. Install all dependencies
npm run install:all

# 3. Start backend (port 3001)
npm run dev:backend

# 4. Open a new terminal, start frontend (port 5173, auto-proxies /api → 3001)
npm run dev:frontend

Visit http://localhost:5173 in your browser.

Works on any device with Docker installed (Linux / macOS / Windows).

Method A: docker-compose (Recommended)

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

Method B: docker run (main app only)

git clone https://github.com/cropflre/nowen-note.git
cd nowen-note
docker build -t nowen-note .

mkdir -p /opt/nowen-note/data
docker run -d \
  --name nowen-note \
  --restart unless-stopped \
  -p 3001:3001 \
  -v /opt/nowen-note/data:/app/data \
  -e DB_PATH=/app/data/nowen-note.db \
  nowen-note

Visit http://<your-ip>:3001 in your browser.

Service Ports:

Environment Variables:

Supports Windows (NSIS installer), macOS (DMG), and Linux (AppImage).

# Development run
npm run electron:dev

# Build for release
npm run electron:build

Output goes to the release/ directory. The desktop client automatically forks the backend process and stores data in the user's nowen-data/ directory.

Built with Capacitor 8 as a native Android app, connecting to a remote server.

# 1. Build frontend
npm run build:frontend

# 2. Sync to Android project
npx cap sync android

# 3. Open and build in Android Studio
npx cap open android

On first launch, configure the server address (IP:port or domain) to connect to your deployed nowen-note backend via HTTP.

Android Icon: Custom-designed Nowen Note brand icon — dark background (#0D1117) + white note paper + blue brand letter N + pencil decoration, supporting Android Adaptive Icons.

All NAS platforms with Docker support follow the same general steps:

1. Build & export image on your PC: docker build -t nowen-note . && docker save nowen-note -o nowen-note.tar
2. Import nowen-note.tar into your NAS Docker manager
3. Create container with:
   • Port mapping: host 3001 → container 3001
   • Volume mapping: host folder → container /app/data
   • Restart policy: always / unless-stopped
4. Visit http://<nas-ip>:3001

Important: Always map the /app/data directory to persist your database. Back up the nowen-note.db file for data safety, or use the built-in backup API at /api/backups.

• JWT Token authentication (30-day expiry)
• Login page with animation and default credential hints
• Change username / password (requires current password verification)
• Automatic SHA256 → bcrypt password hash upgrade
• Client mode: server address configuration for Electron / Android / file:// protocol

• Three-column layout: Sidebar + Note List + Editor (all resizable via drag, double-click to reset)
• Tiptap rich-text editor: Markdown shortcuts, code highlighting, image upload, task lists
• Note operations: Pin, favorite, lock (frontend + backend dual-layer protection), soft delete (trash), restore, permanent delete
• Move notes: Right-click "Move to..." modal (tree notebook selector) + quick notebook switch in editor header
• Word count: Real-time word and character count (CJK characters counted individually, English by whitespace)
• Note outline: Auto-extract H1-H3 headings into outline panel with click-to-scroll navigation
• Calendar filter: Calendar button in note list header, filter notes by update date
• Optimistic locking: Version field to prevent edit conflicts
• Keyboard shortcut: Alt+N for quick note creation

• Unlimited nested hierarchy (tree structure)
• Context menu: New note, new sub-notebook, change icon, rename, delete
• Inline rename: In-place <input> editing, Enter to save, Escape to cancel
• Custom icons: Click notebook icon or right-click "Change Icon" to open Emoji picker (5 categories: Objects/Smileys/Tech/Nature/Food)

• AI Writing Assistant: Triggered on text selection, 10 operations
  • Continue, rewrite, polish, shorten, expand
  • Translate (CN↔EN), summarize, explain, fix grammar
  • Apply via "Replace selection" or "Insert after cursor"
• AI Title Generation: One-click title generation based on note content
• AI Tag Suggestion: Smart tag recommendation with auto-creation
• AI Knowledge Q&A (RAG):
  • Retrieves related notes via FTS5 + LIKE fuzzy search
  • Assembles RAG prompt with note snippets as context
  • SSE streaming output with Markdown rendering
  • Multi-turn conversation (last 6 messages as history)
  • Displays referenced note source tags
• Multi-provider support:

• Card-style provider selection: Gradient icons, config status indicators, auto-fill URL & model
• Connection test & model list fetch: Real-time configuration validation

• Link sharing: One-click shareable link generation with short URL copy
• Password protection: Optional access password with frontend verification page
• Expiry control: 1 hour / 1 day / 7 days / 30 days / permanent options
• Max view count: Limit the number of views for a shared link
• Permission management: Read-only / commentable permission modes
• Inline comments: Anchor-based inline annotations, replies, and resolved marks
• Share management: View all shares, access statistics, one-click disable/delete
• Security: Rate limiting (60 req/min for access + 10 req/min for password verification), security headers

• Auto-snapshot: Every save automatically creates a version snapshot
• Version list: All historical versions displayed in reverse chronological order
• Version comparison: View title and content of any historical version
• Rollback: One-click restore to any previous version
• Change summary: Automatic change type recording (edit/create/rollback)

• Visual mind map editor with custom tree layout algorithm
• Node operations: add child, edit, delete, collapse/expand
• Keyboard shortcuts (Tab/Enter/Delete/Space)
• Mini-map navigation, zoom/pan, touch gestures
• Right-click export: PNG (2x HD), SVG, .xmind format
• Mobile responsive: long-press to edit nodes, long-press list items for export menu, adaptive layout

• Task Center: Dedicated task management panel with desktop three-column layout (filter panel + list + detail)
• Priority levels: High / Medium / Low
• Due dates: Date picker with smart display (today/tomorrow/this week/overdue)
• Subtasks: Parent-child task breakdown
• Multi-filter: All / Today / This Week / Overdue / Completed
• Task statistics: Completion rate, overdue count summary
• Mobile adaptive: Horizontal scrollable filter tabs, full-screen task detail overlay, touch-friendly delete buttons

• Weibo-style timeline: Quick one-liner posting, lightweight and fast
• Compose box: Text input + mood selection (12 moods) + Ctrl+Enter quick post
• Moment cards: Content + mood emoji + relative time display + delete (with confirmation)
• Timeline grouping: Auto-grouped by date (today/yesterday/specific date), cursor-based pagination
• Stats overview: Total moments count + today's post count

• Visual pipeline editor: Drag-and-drop step arrangement with real-time preview
• 5 step types:
  • AI Summary — Auto-generate note summaries
  • AI Translation — Batch translate note content
  • AI Tags — Smart tag recommendation and association
  • Content Formatting — Auto optimize layout
  • Export — Batch export as Markdown/HTML/JSON
• Built-in templates: Pre-configured pipelines (weekly report, knowledge organization, translation, etc.)
• Batch note selection: Multi-select notes as pipeline input
• Execution progress: Real-time status and results for each step

• Hot reload: Auto-scan data/plugins/ directory for plugins
• Sandboxed execution: Isolated plugin code execution for safety
• Standardized interface: Plugin manifest.json declaration (name/version/capabilities)
• Capability registration: note-processor (note processing), exporter (export), etc.
• API management: List plugins / reload / execute specific plugin

• 12 event types:
  • note.created / note.updated / note.deleted / note.trashed
  • notebook.created / notebook.deleted
  • tag.created
  • task.created / task.completed
  • pipeline.completed
  • plugin.executed
  • * (wildcard: receive all events)
• HMAC-SHA256 signature: X-Nowen-Signature header for tamper prevention
• Auto-retry: Up to 3 attempts with exponential backoff (1s → 2s → 4s)
• 10-second timeout: Prevents blocking on slow callbacks
• Delivery logs: Complete record of each delivery (status code, response body, attempt count)
• Test delivery: One-click test event to verify Webhook configuration

• 10 categories: auth / note / notebook / tag / task / share / ai / pipeline / plugin / system
• 3 levels: info / warn / error
• Auto-logging: Key operations (note create/delete, etc.) automatically recorded
• Multi-dimensional query: By user / category / level / target / date range / pagination
• Statistics dashboard: Total records, today's operations, by-category/level breakdown
• Auto-cleanup: Configurable retention period (default 90 days)

• Two backup modes:
  • db-only — Database file backup (SQLite online backup)
  • full — Full backup (JSON export of all table data)
• Auto-backup: Database backup every 24 hours on startup, retains latest 10
• SHA256 checksum: Auto-generated checksum for each backup file
• Online download: Download backup files directly via API
• One-click restore: Transactional restore from full backup, showing row counts per table
• Backup management: List / create / download / delete backups

• Based on SQLite FTS5 virtual tables
• Auto-synced via triggers (INSERT/UPDATE/DELETE)
• Searches both title and contentText

• Many-to-many relationships with colored tags
• Sidebar tag panel for quick filtering

• Reusable component (frosted glass panel + animated transitions)
• Four-direction edge collision detection (menu never overflows screen, 8px safe margin)
• Supports separators, danger action highlighting, disabled states
• Available on both notebook tree and note list

• Export backup: Full export as ZIP archive (Markdown + YAML frontmatter) with progress bar
• Import notes: Drag-and-drop .md / .txt / .html / .zip files, choose target notebook
• Mi Cloud import: Connect to Xiaomi Cloud via cookie authentication, auto-fetch and batch import
• OPPO Cloud import: Browser console extraction script (AES-encrypted, client-side only), copy script → paste JSON → import
• iPhone/iCloud import: Two import methods
  • Method 1: Export from Mac/iPhone as .txt / .md / .html files and import directly (recommended)
  • Method 2: Browser console script for iCloud web — auto-clicks notes one by one → extracts content → copies JSON to clipboard → paste and import. Automatically converts Apple Notes Checklist to Tiptap taskList format
• Factory reset: Wipe all data and reset admin account, requires typing RESET to confirm

• Appearance: Theme switch (light / dark / system), custom site name and favicon
• Font management: 4 built-in font schemes (default / system / serif / monospace) + custom font upload (otf/ttf/otc/ttc/woff/woff2, batch upload), live preview
• AI settings: AI provider configuration, connection test, model management
• Account Security: Change username and password
• Data Management: Import/export and factory reset

• Light / Dark / System three theme modes
• Collapsible sidebar (icon-only mode)
• Internationalization: Chinese/English language switching
• Smooth Framer Motion animations
• Global keyboard shortcut: Alt+N for quick note creation
• Comprehensive mobile adaptation:
  • Drawer-style sidebar (swipe gesture toggle) + list/editor dual-view switch
  • TaskCenter responsive: desktop three-column → mobile horizontal filter tabs + full-screen detail
  • SettingsModal mobile full-screen + top tab bar navigation
  • EditorPane mobile "More actions" menu (delete/move/AI/outline)
  • Touch-friendly: all hover-dependent buttons always visible on mobile
  • ContextMenu four-direction boundary collision detection
  • Editor meta info auto-wrap, MoveNoteModal responsive width
  • Calendar filter mobile entry, MindMap list long-press export
  • safe-area-inset adaptation (notch / gesture bar)

• Web: Browser access with responsive layout for desktop and mobile
• Electron Desktop: Windows (NSIS) / macOS (DMG) / Linux (AppImage), automatic backend process management, data stored in user directory
• Android Mobile: Native app built with Capacitor, custom brand icon, Release signing support, connects to remote server
• Client Mode: Electron and Android clients support server address configuration via HTTP

Provides 22 callable tools and resources for AI assistants (Claude, Cursor, Windsurf, etc.) to directly interact with the note system.

Setup:

{
  "mcpServers": {
    "nowen-note": {
      "command": "npx",
      "args": ["tsx", "packages/nowen-mcp/src/index.ts"],
      "env": {
        "NOWEN_API_URL": "http://localhost:3001",
        "NOWEN_TOKEN": "your-jwt-token"
      }
    }
  }
}

Tool List (22 tools):

Provides 60+ type-safe API methods with complete coverage of all backend capabilities.

Installation:

npm install @nowen/sdk

Usage Example:

import { NowenClient } from "@nowen/sdk";

const client = new NowenClient({
  baseUrl: "http://localhost:3001",
  token: "your-jwt-token",
});

// List notes
const notes = await client.listNotes({ notebookId: "xxx" });

// Create note
const note = await client.createNote({
  notebookId: "xxx",
  title: "New Note",
  content: "...",
});

// AI knowledge Q&A
const answer = await client.askAI("What are the new features?");

// Create Webhook
const webhook = await client.createWebhook({
  url: "https://your-server.com/hook",
  events: ["note.created", "note.updated"],
});

// Create backup
const backup = await client.createBackup("full");

API Groups:

Manage your note system from the terminal with 8 command groups.

Setup:

# Install dependencies
cd packages/nowen-cli && npm install

# Configure server
npx nowen config set-url http://localhost:3001
npx nowen config set-token <your-jwt-token>

# View config
npx nowen config show

Commands:

# Notes
nowen notes list [--notebook <id>]        # List notes
nowen notes get <id>                       # View note
nowen notes create --notebook <id> --title "Title"  # Create note
nowen notes update <id> --title "New Title" # Update note
nowen notes delete <id>                    # Delete note
nowen notes search <keyword>               # Search notes

# Notebooks
nowen notebooks list                       # List notebooks
nowen notebooks create --name "Name"       # Create notebook

# Tags
nowen tags list                            # List tags
nowen tags create --name "Tag Name"        # Create tag

# Tasks
nowen tasks list [--status <status>]       # List tasks
nowen tasks create --title "Task Name"     # Create task
nowen tasks toggle <id>                    # Toggle completion

# Search
nowen search <keyword>                     # Full-text search

# AI
nowen ai ask "Your question"               # Knowledge Q&A
nowen ai chat "Chat message"               # AI conversation

# Pipelines
nowen pipelines list                       # List pipelines
nowen pipelines run <id> --notes <id1,id2> # Run pipeline

# Config
nowen config show                          # Show config
nowen config set-url <url>                 # Set server URL
nowen config set-token <token>             # Set JWT token

Complete OpenAPI 3.0 specification document, consumable by Swagger UI, Postman, and other tools.

GET http://localhost:3001/api/openapi.json

Covers 16 API groups, 50+ endpoints, with full request/response schema definitions.

┌───────────────────────────────────────────┐
│              Docker Compose                │
│                                           │
│  ┌─────────────────────────────────────┐  │
│  │           nowen-note :3001          │  │
│  │                                     │  │
│  │  ┌─────────────┐                    │  │
│  │  │  Frontend   │                    │  │
│  │  │  React      │                    │  │
│  │  │  Tiptap     │                    │  │
│  │  ├─────────────┤                    │  │
│  │  │  Backend    │                    │  │
│  │  │  Hono       │◄──► External AI:   │  │
│  │  │  SQLite     │     Qwen/OpenAI    │  │
│  │  │  JWT        │     Gemini/DeepSeek│  │
│  │  │             │     Doubao/Ollama  │  │
│  │  └─────────────┘                    │  │
│  └─────────────────────────────────────┘  │
└───────────────────────────────────────────┘

16 data tables + 1 FTS5 full-text search virtual table: