streetwriters/notesnook-sync-server

これは何？

主な機能

• 01Notesnook API、identity、messagingの各サービスを.NET 8プロジェクトとして実行できます。
• 02MongoDBとSiloストレージを含む一式をDocker Composeで起動できます。
• 03設定例を使って、外部のMongoDB、Silo、Garageを利用できます。
• 04Compose profileを通じて、テーマ、CORSプロキシ、inbox APIの各サービスを追加できます。
• 05v3.0.18以降のNotesnookクライアントアプリで、カスタムサーバーURLを指定できます。

ユースケース

• 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

使う前に知っておきたいこと

• !セルフホスティングはアルファ版で、公式ドキュメントやサポートはまだありません。
• !ソースからビルドするには .NET 8 SDK が必要です。
• !フルスタックの実行には、MongoDB や S3 互換ストレージなど、複数のサービスが必要です。
• !AGPL-3.0 の下でライセンスされており、改変したネットワーク経由で提供されるバージョンのソースコード開示が求められます。

収録されている特集

トピック

よくある質問

notesnook-sync-server とは？

Notesnook向けのセルフホスト可能な同期サーバー。.NET 8製でDockerに対応（セルフホスト機能はアルファ版）。 このリポジトリには、Notesnookのノートアプリが接続する同期バックエンドのソースコードがあります。Notesnook API、identity service、リアルタイム同期イベントを扱うmessenger serviceが含まれており、1つのソリューション内で別々の.NET 8プロジェクトとして構成されています。

notesnook-sync-server は無料で使えますか？ライセンスは？

notesnook-sync-server は AGPL-3.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

notesnook-sync-server は今もメンテナンスされていますか？

活発にメンテナンス中。notesnook-sync-server の最終コミットは 2026年11月7日 です。

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