当前位置：首页 > news >正文

Notesnook Sync Server：开源自托管笔记同步服务器的终极指南

news 2026/6/17 6:59:14

Notesnook Sync Server：开源自托管笔记同步服务器的终极指南

【免费下载链接】notesnook-sync-serverSync server for Notesnook (self-hosting in alpha)项目地址: https://gitcode.com/gh_mirrors/no/notesnook-sync-server

在当今数字时代，数据隐私和控制权变得前所未有的重要。Notesnook Sync Server作为一个完整的开源自托管笔记同步解决方案，让您能够完全掌控自己的笔记数据，告别对第三方云服务的依赖。这个强大的同步服务器为Notesnook笔记应用提供后端支持，让您可以在自己的服务器上搭建私有的笔记同步服务。

🚀 什么是Notesnook Sync Server？

Notesnook Sync Server是Notesnook笔记应用的完整后端同步服务器，采用AGPLv3许可证开源。它提供了笔记同步、用户认证、文件存储和实时通信等核心功能，让您能够搭建属于自己的私有笔记同步服务。

核心功能亮点 ✨

🔒 端到端加密同步：所有数据在客户端加密后才发送到服务器
🌐 多设备同步：支持跨设备实时同步笔记和附件
📁 文件存储：集成S3兼容存储，支持附件管理
👥 用户管理：完整的用户认证和授权系统
⚡ 实时通信：基于SSE的实时更新推送
🐳 Docker支持：一键部署，简化运维

🏗️ 系统架构概览

Notesnook Sync Server采用微服务架构设计，包含以下核心组件：

主要服务模块

服务名称	端口	功能描述
Notesnook API	5264	核心同步API服务，处理笔记同步逻辑
Identity Server	8264	用户认证和授权服务
SSE Server	7264	Server-Sent Events服务，提供实时更新
Monograph Server	3000	文档分享和发布服务

数据存储组件

MongoDB：存储用户数据、笔记元数据和同步信息
MinIO/S3：对象存储服务，用于附件和文件存储
Redis：缓存和会话管理

📦 快速部署指南

环境准备

部署Notesnook Sync Server需要以下基础环境：

Docker和Docker Compose（推荐方式）
.NET 8 SDK（源码编译方式）
Git版本控制系统

Docker一键部署 🐳

最简单快速的部署方式是通过Docker Compose：

# 下载docker-compose配置文件 wget https://raw.githubusercontent.com/streetwriters/notesnook-sync-server/master/docker-compose.yml # 启动所有服务 docker compose up -d

环境变量配置

创建.env配置文件，包含必要的环境变量：

INSTANCE_NAME=MyNotesnookServer NOTESNOOK_API_SECRET=your-secret-key DISABLE_SIGNUPS=false SMTP_HOST=smtp.example.com SMTP_PORT=587 SMTP_USERNAME=your-email SMTP_PASSWORD=your-password

源码编译部署

如果您希望从源码构建：

# 克隆仓库 git clone https://gitcode.com/gh_mirrors/no/notesnook-sync-server # 进入项目目录 cd notesnook-sync-server # 还原依赖包 dotnet restore Notesnook.sln # 构建项目 dotnet build Notesnook.sln # 运行API服务 dotnet run --project Notesnook.API/Notesnook.API.csproj

🔧 配置详解

核心配置文件

项目的主要配置位于以下位置：

Notesnook.API/Program.cs- 主程序入口和服务器配置
Streetwriters.Common/Servers.cs- 服务器端口和连接配置
docker-compose.yml- Docker容器编排配置

数据库配置

在docker-compose.yml中，您可以配置MongoDB副本集和MinIO存储：

notesnook-db: image: mongo:7.0.12 command: --replSet rs0 --bind_ip_all volumes: - dbdata:/data/db notesnook-s3: image: minio/minio:latest environment: MINIO_BROWSER: "on" command: server /data/s3 --console-address :9090

🔐 安全特性

数据加密保护

Notesnook Sync Server采用多层安全策略：

传输层加密：所有API通信支持HTTPS
端到端加密：笔记内容在客户端加密
安全认证：基于JWT的令牌认证系统
访问控制：细粒度的权限管理

认证流程

认证系统位于Streetwriters.Identity/Controllers/AccountController.cs，提供：

用户注册和登录
双因素认证支持
令牌刷新机制
会话管理

📊 监控和运维

健康检查端点

每个服务都提供健康检查端点：

Notesnook API:http://localhost:5264/health
Identity Server:http://localhost:8264/health
SSE Server:http://localhost:7264/health

日志和监控

项目集成了OpenTelemetry进行应用监控，配置位于Notesnook.API/Startup.cs：

services.AddOpenTelemetry() .ConfigureResource(resource => resource .AddService(serviceName: "Notesnook.API")) .WithMetrics((builder) => builder .AddMeter("Notesnook.API.Metrics.Sync") .AddPrometheusExporter());