notesnook-sync-server

> 编程语言

Open source

Sync server for Notesnook (self-hosting in alpha)

902 stars0 likes0 views

Website GitHub

About

Sync server for Notesnook (self-hosting in alpha)

Notesnook Sync Server

This repo contains the full source code of the Notesnook Sync Server licensed under AGPLv3.

Building

From source

Requirements:

.NET 8
git

The first step is to clone the repository:

bash

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

# change directory
cd notesnook-sync-server

Once you are inside the ./notesnook-sync-server directory, run:

bash

# this might take a while to complete
dotnet restore Notesnook.sln

Then build all projects:

bash

dotnet build Notesnook.sln

To run the Notesnook.API project:

bash

dotnet run --project Notesnook.API/Notesnook.API.csproj

To run the Streetwriters.Messenger project:

bash

dotnet run --project Streetwriters.Messenger/Streetwriters.Messenger.csproj

To run the Streetwriters.Identity project:

bash

dotnet run --project Streetwriters.Identity/Streetwriters.Identity.csproj

Using docker

The sync server can easily be started using Docker.

Download docker-compose.yml and .env:

bash

wget https://raw.githubusercontent.com/streetwriters/notesnook-sync-server/master/docker-compose.yml
wget https://raw.githubusercontent.com/streetwriters/notesnook-sync-server/master/.env

Edit .env and set at least NOTESNOOK_API_SECRET. See .env for all configuration options.

Then start the stack:

bash

docker compose up

This sets up MongoDB, MinIO, and the Notesnook services.

Optional services (themes-server, cors-proxy, inbox-api): docker compose --profile extras up

For external MongoDB, MinIO, or Garage deployments, see examples/.

TODO Self-hosting

Note: Self-hosting the Notesnook Sync Server is now possible, but without support. Documentation will be provided at a later date. We are working to enable full on-premise self-hosting, so stay tuned!

Open source the Sync server
Open source the Identity server
Open source the SSE Messaging infrastructure
Fully Dockerize all services
Use self-hosted Minio for S3 storage
Publish on DockerHub
Add settings to change server URLs in Notesnook client apps (starting from v3.0.18)
Write self hosting docs