# DeepNote **Repository Path**: decentant/deep-note ## Basic Information - **Project Name**: DeepNote - **Description**: 私有化部署的团队云笔记 - **Primary Language**: Unknown - **License**: AGPL-3.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-05 - **Last Updated**: 2026-11-05 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # DeepNote — 私有化部署云同步笔记 对标群晖 DS Note 的私有化云笔记:富文本编辑、多端增量同步(Electron 桌面端 / 浏览器 Web 端)、团队空间与权限管控、分享链接、版本历史、AI 问答(RAG,严格按空间权限检索)。基于自研 [onflow-framework](../onflow-framework) 构建。 ## 工程结构 ``` deepnote/ ├── Document/ # 需求与设计文档(仓库外层) ├── pom.xml # parent = onflow-framework:1.3-SNAPSHOT ├── note/ # 笔记业务模块 │ ├── note-entity/ # 13 张业务表实体 + 常量(表结构见 Flyway V10) │ ├── note-adaptor/ # mapper / qo / vo / 13 个 Manager / AI 客户端 │ └── note-service/ # 管理端 .adw 接口(Service + Controller) ├── deepnote-portal/ # to-C 启动工程(:14011,C端 .dnw 接口,11 个控制器) ├── deepnote-admin-boot/ # 管理端启动工程(:14010,/admin) ├── deepnote-web-admin/ # 管理后台前端(fork 自 onflow-web-admin,pnpm build:pro) ├── deepnote-web/ # 笔记客户端 SPA(Vue3 + Element Plus + Tiptap + Dexie) ├── deepnote-desktop/ # Electron 壳(Windows,加载 deepnote-web 构建产物) └── deploy/ # nginx.conf / systemd / 菜单 SQL ``` ## 同步模型(DS Note 式) - 服务端每条笔记维护 `rev` 版本号,所有变更写 `nt_sync_journal`(自增 id 即全局游标) - 客户端本地 IndexedDB 全量缓存(Dexie),**离线可读可写** - `pull`:按游标增量拉取,墓碑记录负责删除传播 - `push`:本地变更队列带 `baseRev` 乐观锁上传;**冲突时服务器优先、本地差异存「[冲突]」副本笔记** - 新建笔记先以本地临时负数 id 存在,推送成功后无缝替换为服务器 id - 触发时机:变更后 2s 防抖推送、每 60s / 窗口聚焦时拉取、Ctrl+S 手动保存 ## 本地开发 0. 环境:JDK 21、Node 22、pnpm 10、MySQL 与 Redis(地址配在本机私有档,不入库)。 Maven 用 IDEA 自带:`C:\Software\JetBrains\IntelliJ IDEA 2025.2.5\plugins\maven\lib\maven3\bin\mvn.cmd` 1. 安装框架与业务模块到本地仓库(业务库 `deepnote` 首次启动自动创建,表结构由 Flyway V1~V3 + V10 建立): ```bash mvn -f onflow-framework/pom.xml clean install -DskipTests mvn -f deepnote/deepnote/pom.xml install -DskipTests ``` 2. 启动后端(开发档 `application-develop.yml` 含数据源/Redis/RSA 配置,**该文件不入库**,缺失时从 `application.yml` 复制并补齐): ```bash java -jar deepnote-admin-boot/target/deepnote-admin-boot-1.0-SNAPSHOT.jar java -jar deepnote-portal/target/deepnote-portal-1.0-SNAPSHOT.jar ``` 3. 初始化管理端数据:执行 `deploy/sql/deepnote_menu.sql`(笔记管理菜单);首次登录前把 superadmin 密码改成你自己的(框架种子账号密码未知)。 4. 前端: ```bash cd deepnote-web && pnpm install && pnpm dev # 笔记客户端 http://localhost:14012 cd deepnote-web-admin && pnpm install && pnpm dev # 管理后台(登录后见「笔记管理」目录) ``` 5. 桌面端: ```bash cd deepnote-web && pnpm build # 先出 SPA 产物 cd ../deepnote-desktop && npm install && npm run dev # 开发(--dev 走 14012) npm run dist # 打 Windows 安装包(dist/) ``` ## AI / RAG 配置 `deepnote-portal/src/main/resources/application.yml` 的 `deepnote.ai` 段: - `chat`:OpenAI 兼容对话接口(默认指向 DeepSeek,填入 API Key 即用) - `embedding`:OpenAI 兼容向量接口(硅基流动/Ollama 等);**不配置时 RAG 自动降级为关键词检索** - 检索范围 = 调用者可见空间 ∩ 请求空间,SQL 按 `space_id IN` 过滤;回收站与已删笔记的分块同步清理 - 管理端可按用户关闭 AI(用户配额页) ## 默认账号与端口 | 项 | 值 | |---|---| | 管理端 | http://127.0.0.1:14010/admin(superadmin,首次登录后请修改密码) | | C端 API + 内置 Web | http://127.0.0.1:14011(`pnpm build` 后 dist 自动打进 portal jar,单进程即完整 C端) | | Web 客户端 | http://localhost:14012(vite dev) | ## 生产部署 **单服务模式(最省事)**:只跑一个 portal 进程,Web 界面与 C端 API 同源,不需要 nginx / node: ```bash cd deepnote-web && pnpm build # 先出 SPA 产物 mvn -f deepnote/pom.xml -pl deepnote-portal -am package -DskipTests # dist 自动打进 jar(target/classes/static) java -jar deepnote-portal/target/deepnote-portal-1.0-SNAPSHOT.jar # http://服务器IP:14011 即是完整 C端 ``` dist 不存在时打包静默跳过(纯后端 jar 照常构建);前端改动只需重跑 `pnpm build` + `mvn package`。管理后台(deepnote-web-admin)如需部署,执行 `pnpm build:pro` 把 dist-pro 放到静态目录即可。 **nginx 同域模式(要带管理后台/桌面更新源时)**:见 `deploy/nginx.conf` 与 `deploy/systemd/`:`/` 托管 Web 客户端、`/manage/` 托管管理后台、`/admin/` 反代管理端、`/nt*` 反代 portal、`/desktop/` 托管 Electron 安装包(electron-updater generic feed,客户端 package.json 的 `publish.url` 指向它)。 服务器上需要一份 `application-prod.yml`(参照 develop 档,改数据库/Redis/RSA/file.local-path)。 ## 已知边界(V1) - 同步 delete 语义 = 移入回收站(可恢复);彻底删除只在在线接口 - 附件图片以内联引用存储,客户端按需拉 blob 缓存;换设备首开大图有加载延迟 - 同步日志 `nt_sync_journal` 无自动清理(私有部署规模下可定期手动清理历史段) - 单条笔记加密(DS Note 有)规划在 V2 ## 开源协议 本项目采用 **AGPL-3.0-only** 协议开源,完整条款见 [LICENSE](LICENSE)。 - 个人使用、学习、审计、修改和自部署均免费。 - 分发修改版,或通过网络向用户提供服务时,必须按 AGPL-3.0 向用户提供完整对应的源代码。 - 如需闭源集成、商业分发、SaaS 不公开源码或 OEM 贴牌,请购买商业授权,详见 [COMMERCIAL.md](COMMERCIAL.md)。 - "DeepNote" 名称与 Logo 的商标使用权不随代码授权,详见 [TRADEMARK.md](TRADEMARK.md)。 - 贡献代码前请阅读 [CONTRIBUTING.md](CONTRIBUTING.md),并同意 [CLA.md](CLA.md)。 Copyright (C) 2026 DecentAnt