Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/streetwriters/notesnook-sync-server
Sync server for Notesnook (self-hosting in alpha)
https://github.com/streetwriters/notesnook-sync-server
notesnook
Last synced: 1 day ago
JSON representation
Sync server for Notesnook (self-hosting in alpha)
- Host: GitHub
- URL: https://github.com/streetwriters/notesnook-sync-server
- Owner: streetwriters
- License: agpl-3.0
- Created: 2022-12-26T08:19:08.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T16:00:28.000Z (2 months ago)
- Last Synced: 2024-09-06T19:05:03.645Z (2 months ago)
- Topics: notesnook
- Language: C#
- Homepage: https://notesnook.com/
- Size: 298 KB
- Stars: 351
- Watchers: 39
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS
Awesome Lists containing this project
README
# Notesnook Sync Server
This repo contains the full source code of the Notesnook Sync Server licensed under AGPLv3.
## Building
### From source
Requirements:
1. [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
2. [git](https://git-scm.com/downloads)
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.
```bash
wget https://raw.githubusercontent.com/streetwriters/notesnook-sync-server/master/docker-compose.yml
```
And then use Docker Compose to start the servers:
```bash
docker compose up
```
This takes care of setting up everything including MongoDB, Minio etc.
## 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!**
- [x] Open source the Sync server
- [x] Open source the Identity server
- [x] Open source the SSE Messaging infrastructure
- [x] Fully Dockerize all services
- [x] Use self-hosted Minio for S3 storage
- [x] Publish on DockerHub
- [x] Add settings to change server URLs in Notesnook client apps (starting from v3.0.18)
- [ ] Write self hosting docs
## License
```
This file is part of the Notesnook Sync Server project (https://notesnook.com/)
Copyright (C) 2023 Streetwriters (Private) Limited
This program is free software: you can redistribute it and/or modify
it under the terms of the Affero GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Affero GNU General Public License for more details.
You should have received a copy of the Affero GNU General Public License
along with this program. If not, see .
```