{"id":18611164,"url":"https://github.com/streetwriters/notesnook-sync-server","last_synced_at":"2025-04-05T20:07:42.187Z","repository":{"id":128976733,"uuid":"582252349","full_name":"streetwriters/notesnook-sync-server","owner":"streetwriters","description":"Sync server for Notesnook (self-hosting in alpha)","archived":false,"fork":false,"pushed_at":"2024-09-06T16:00:28.000Z","size":305,"stargazers_count":351,"open_issues_count":2,"forks_count":14,"subscribers_count":39,"default_branch":"master","last_synced_at":"2024-09-06T19:05:03.645Z","etag":null,"topics":["notesnook"],"latest_commit_sha":null,"homepage":"https://notesnook.com/","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/streetwriters.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-26T08:19:08.000Z","updated_at":"2024-09-06T17:02:29.000Z","dependencies_parsed_at":"2023-06-15T03:30:22.599Z","dependency_job_id":"901eb7f6-b031-4333-8305-75b5cba803ac","html_url":"https://github.com/streetwriters/notesnook-sync-server","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetwriters%2Fnotesnook-sync-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetwriters%2Fnotesnook-sync-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetwriters%2Fnotesnook-sync-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetwriters%2Fnotesnook-sync-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/streetwriters","download_url":"https://codeload.github.com/streetwriters/notesnook-sync-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247393570,"owners_count":20931812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["notesnook"],"created_at":"2024-11-07T03:12:54.935Z","updated_at":"2025-04-05T20:07:42.165Z","avatar_url":"https://github.com/streetwriters.png","language":"C#","funding_links":[],"categories":["others","C#"],"sub_categories":[],"readme":"# Notesnook Sync Server\n\nThis repo contains the full source code of the Notesnook Sync Server licensed under AGPLv3.\n\n## Building\n\n### From source\n\nRequirements:\n\n1. [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)\n2. [git](https://git-scm.com/downloads)\n\nThe first step is to `clone` the repository:\n\n```bash\ngit clone https://github.com/streetwriters/notesnook-sync-server.git\n\n# change directory\ncd notesnook-sync-server\n```\n\nOnce you are inside the `./notesnook-sync-server` directory, run:\n\n```bash\n# this might take a while to complete\ndotnet restore Notesnook.sln\n```\n\nThen build all projects:\n\n```bash\ndotnet build Notesnook.sln\n```\n\nTo run the `Notesnook.API` project:\n\n```bash\ndotnet run --project Notesnook.API/Notesnook.API.csproj\n```\n\nTo run the `Streetwriters.Messenger` project:\n\n```bash\ndotnet run --project Streetwriters.Messenger/Streetwriters.Messenger.csproj\n```\n\nTo run the `Streetwriters.Identity` project:\n\n```bash\ndotnet run --project Streetwriters.Identity/Streetwriters.Identity.csproj\n```\n\n### Using docker\n\nThe sync server can easily be started using Docker.\n\n```bash\nwget https://raw.githubusercontent.com/streetwriters/notesnook-sync-server/master/docker-compose.yml\n```\n\nAnd then use Docker Compose to start the servers:\n\n```bash\ndocker compose up\n```\n\nThis takes care of setting up everything including MongoDB, Minio etc.\n\n## TODO Self-hosting\n\n**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!**\n\n- [x] Open source the Sync server\n- [x] Open source the Identity server\n- [x] Open source the SSE Messaging infrastructure\n- [x] Fully Dockerize all services\n- [x] Use self-hosted Minio for S3 storage\n- [x] Publish on DockerHub\n- [x] Add settings to change server URLs in Notesnook client apps (starting from v3.0.18)\n- [ ] Write self hosting docs\n\n## License\n\n```\nThis file is part of the Notesnook Sync Server project (https://notesnook.com/)\n\nCopyright (C) 2023 Streetwriters (Private) Limited\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the Affero GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nAffero GNU General Public License for more details.\n\nYou should have received a copy of the Affero GNU General Public License\nalong with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreetwriters%2Fnotesnook-sync-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstreetwriters%2Fnotesnook-sync-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreetwriters%2Fnotesnook-sync-server/lists"}