Repolode
streetwriters

streetwriters/notesnook-sync-server

Notesnook 笔记应用的自托管同步服务端,基于 .NET 8 构建,支持 Docker 部署。

Star
950
Fork
77
未关闭 Issue
29
最近提交
昨天

这是什么?

本仓库包含 Notesnook 笔记应用所连接的同步后端源码,由 Notesnook API、身份认证服务和用于实时同步事件的消息服务组成,均为同一解决方案下的独立 .NET 8 项目。

可以使用 .NET SDK 从源码构建,也可以通过 Docker Compose 一键启动,其中包括 MongoDB、提供 S3 兼容文件存储的 Silo 以及 Notesnook 各服务。主题服务、CORS 代理和 inbox API 等可选组件可通过 Compose profile 启用。examples 目录提供了连接外部 MongoDB、Silo 或 Garage 的配置示例。

目前自托管已可用,但官方不提供支持,部署文档仍在编写中。3.0.18 及以后版本的客户端应用支持修改为自定义服务器地址。

核心功能

  • 01以 .NET 8 项目形式运行 Notesnook API、身份认证和消息服务。
  • 02通过 Docker Compose 启动完整服务栈,包含 MongoDB 与 Silo 存储。
  • 03提供示例配置,可对接外部 MongoDB、Silo 或 Garage。
  • 04通过 Compose profile 可选启用主题、CORS 代理和 inbox API 服务。
  • 053.0.18 及以后版本的客户端可修改为自定义服务器地址。

适用场景

  • 为 Notesnook 部署自己的同步后端,让笔记数据保存在自有基础设施上。
  • 研究或修改 C# 编写的同步服务端实现。
  • 在本地使用 Docker Compose 测试 Notesnook 同步功能。

快速上手

  1. 1

    克隆仓库

    git clone https://github.com/streetwriters/notesnook-sync-server.git
  2. 2

    进入项目目录

    cd notesnook-sync-server
  3. 3

    还原依赖

    dotnet restore Notesnook.sln
  4. 4

    构建所有项目

    dotnet build Notesnook.sln

使用前须知

  • 自托管目前处于alpha阶段,官方暂无文档和支持。
  • 从源码构建需要 .NET 8 SDK。
  • 完整服务栈依赖 MongoDB 和兼容 S3 的存储等多个服务。
  • 采用 AGPL-3.0 许可证,修改后通过网络提供服务时需要公开源代码。

收录于专题

标签

常见问题

notesnook-sync-server 是什么?
Notesnook 笔记应用的自托管同步服务端,基于 .NET 8 构建,支持 Docker 部署。 本仓库包含 Notesnook 笔记应用所连接的同步后端源码,由 Notesnook API、身份认证服务和用于实时同步事件的消息服务组成,均为同一解决方案下的独立 .NET 8 项目。
notesnook-sync-server 可以免费使用吗?用的什么许可证?
notesnook-sync-server 以 AGPL-3.0 许可证开源。用于商业产品前,请先确认许可证条款。
notesnook-sync-server 还在维护吗?
活跃维护中。notesnook-sync-server 最近一次提交是在 2026年11月6日。
notesnook-sync-server 适合用来做什么?
为 Notesnook 部署自己的同步后端,让笔记数据保存在自有基础设施上。 研究或修改 C# 编写的同步服务端实现。 在本地使用 Docker Compose 测试 Notesnook 同步功能。
notesnook-sync-server 怎么安装和运行?
克隆仓库: git clone https://github.com/streetwriters/notesnook-sync-server.git 进入项目目录: cd notesnook-sync-server 还原依赖: dotnet restore Notesnook.sln 构建所有项目: dotnet build Notesnook.sln
在哪里获取 notesnook-sync-server?
源代码和安装说明在 GitHub 上:https://github.com/streetwriters/notesnook-sync-server

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目