Repolode
Submit
streetwriters

streetwriters/notesnook-sync-server

Self-hostable sync server for the Notesnook note-taking app, built on .NET 8 with Docker support (self-hosting still in alpha).

View on GitHubWebsite
Stars
950
Forks
77
Open issues
29
Last commit
yesterday

What is it?

This repository holds the source code for the sync backend that the Notesnook note-taking apps connect to. It includes the Notesnook API, an identity service, and a messenger service for real-time sync events, which are built as separate .NET 8 projects in one solution.

The project can be built from source with the .NET SDK, or started with Docker Compose, which brings up MongoDB, Silo for S3-compatible file storage, and the Notesnook services. Optional containers for themes, a CORS proxy, and an inbox API are available through a Compose profile. Example configurations for external MongoDB, Silo, or Garage are provided in the examples folder.

Self-hosting is described as possible but without official support, and the setup documentation is still pending. Client apps can be pointed at custom server URLs starting from version 3.0.18.

Key features

  • 01Runs the Notesnook API, identity, and messaging services as .NET 8 projects.
  • 02Starts the full stack with Docker Compose, including MongoDB and Silo storage.
  • 03Supports external MongoDB, Silo, or Garage deployments via example configs.
  • 04Offers optional themes, CORS proxy, and inbox API services through a Compose profile.
  • 05Lets Notesnook client apps point to custom server URLs from v3.0.18.

Use cases

  • Hosting your own sync backend for Notesnook so note data stays on your infrastructure.
  • Developers studying or modifying the sync server implementation in C#.
  • Testing Notesnook sync locally with Docker Compose before a wider deployment.

Quick start

  1. 1

    Clone the repository

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

    Change into the project directory

    cd notesnook-sync-server
  3. 3

    Restore dependencies

    dotnet restore Notesnook.sln
  4. 4

    Build all projects

    dotnet build Notesnook.sln

Things to know

  • Self-hosting is in alpha and has no official documentation or support yet.
  • Requires .NET 8 SDK to build from source.
  • The full stack depends on several services such as MongoDB and S3-compatible storage.
  • Licensed under AGPL-3.0, which requires source disclosure for modified network-served versions.

In collections

Self-hosted apps

Topics

#notes#self-hosted#sync#dotnet#docker#csharp#mongodb#s3#notesnook

FAQ

What is notesnook-sync-server?
Self-hostable sync server for the Notesnook note-taking app, built on .NET 8 with Docker support (self-hosting still in alpha). This repository holds the source code for the sync backend that the Notesnook note-taking apps connect to. It includes the Notesnook API, an identity service, and a messenger service for real-time sync events, which are built as separate .NET 8 projects in one solution.
Is notesnook-sync-server free to use? What license does it have?
notesnook-sync-server is open source under the AGPL-3.0 license. Check the license terms before using it in commercial products.
Is notesnook-sync-server still maintained?
Actively maintained. The last commit to notesnook-sync-server was on Nov 6, 2026.
What can I use notesnook-sync-server for?
Hosting your own sync backend for Notesnook so note data stays on your infrastructure. Developers studying or modifying the sync server implementation in C#. Testing Notesnook sync locally with Docker Compose before a wider deployment.
How do I install notesnook-sync-server?
Clone the repository: git clone https://github.com/streetwriters/notesnook-sync-server.git Change into the project directory: cd notesnook-sync-server Restore dependencies: dotnet restore Notesnook.sln Build all projects: dotnet build Notesnook.sln
Where can I get notesnook-sync-server?
The source code and installation instructions are on GitHub: https://github.com/streetwriters/notesnook-sync-server

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects