Kurotsuki Sync

by Kurotsuki
5
4
3
2
1
Score: 50/100

Description

Reviews

No reviews yet.

Stats

1
stars
106
downloads
0
forks
18
days
7
days
7
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
36
commits

Latest Version

README file from

Github

🌙 Kurotsuki Sync


🇬🇧 English

Kurotsuki Sync is an open-source, self-hosted, local-first alternative to proprietary Obsidian relay and synchronization services. Powered by Yjs CRDTs and WebSockets, it enables real-time collaborative editing, instant cursor presence, multi-vault profile switching, and strict Role-Based Access Control (RBAC).

✨ Key Features

  • ⚡ Live Collaborative Editing: Multiple users editing the exact same note simultaneously with conflict-free merges (CRDT).
  • 👥 Real-Time Cursor Presence & Avatars: See collaborator cursor positions, active text selections, and note locations in real time.
  • 🗂️ Multi-Vault Profile Switcher: Switch between multiple remote vaults and relay rooms with 1 click without leaving Obsidian.
  • 🔒 Client-Side Read-Only Enforcement: Users with the viewer role are locked in read-only mode in CodeMirror 6 with clear visual badges.
  • 📁 File Explorer Reconciliation: Add or delete files from Windows Explorer, Finder, or terminal: changes sync automatically while Obsidian runs or when launched.
  • 👥 Peer List Sidebar View: Dockable sidebar leaf showing online collaborators, their custom avatars, and clickable active note links.
  • 📜 Conflict History & Audit Inspector: Built-in modal to view CRDT merge events, file synchronization status, and server communication logs.
  • 📶 Real-Time Ping Indicator: Live connection latency display in the Obsidian status bar.
  • 🔒 100% Sovereign & Private: Connects directly to your own self-hosted Kurotsuki-Sync-Server.

📦 Installation

  1. Install Obsidian42 - BRAT from Community Plugins in Obsidian.
  2. In BRAT settings, click Add Beta plugin.
  3. Enter repository URL: https://github.com/Kurotsuki-Studio/Kurotsuki-Sync.
  4. BRAT installs and automatically keeps the plugin up to date.
Option 2: Manual Installation (GitHub Release)
  1. Download main.js, manifest.json, and styles.css from the Latest Release.
  2. Inside your Obsidian vault, create the folder:
    <Your-Vault>/.obsidian/plugins/obsidian-kurotsuki-sync/
    
  3. Copy main.js, manifest.json, and styles.css into that directory.
  4. Reload Obsidian, open Settings → Community plugins, and toggle Kurotsuki Sync ON.

⚙️ Plugin Configuration

In Obsidian Settings → Kurotsuki Sync:

Option Description Example
Relay Server URL WebSocket URL of your self-hosted relay ws://192.168.1.50:3050 or wss://relay.yourdomain.com
Authentication Secret / Token Token configured on your relay (AUTH_TOKEN or generated user token) kurotsuki_vault
Vault / Room ID Shared workspace or room name Kurotsuki Vault
Display Name Your visible nickname for collaborator cursor badges AngmarRoiSorcier
User Color Color of your avatar and live cursor highlight #ff0000
Sync Mode Choose between Entire Vault or Selective Shared Folders Entire Vault

🔄 Server Setup & VPS Update Tutorial

To run or update your self-hosted server on a VPS, refer to the Kurotsuki Sync Server Guide.

Quick commands to update the server on your VPS:

cd /root/Kurotsuki-Sync-Server
git pull origin main
docker compose down
docker compose up -d --build
docker compose logs -f

🇫🇷 Français

Kurotsuki Sync est une alternative open-source, auto-hébergeable et "local-first" aux services propriétaires Obsidian Sync et Relay. Basé sur Yjs et WebSockets, il offre la collaboration en temps réel, la présence des curseurs, la gestion multi-coffres et le contrôle des permissions par rôle (RBAC).

✨ Fonctionnalités Principales

  • ⚡ Édition Collaborative Temps Réel : Éditez la même note à plusieurs sans aucun conflit de fusion grâce aux CRDTs Yjs.
  • 👥 Curseurs & Avatars en Direct : Visualisez les curseurs de vos collaborateurs, leurs sélections de texte et la note sur laquelle ils travaillent.
  • 🗂️ Sélecteur Multi-Coffres : Passez d'un coffre ou salon distant à un autre en 1 clic directement dans Obsidian.
  • 🔒 Protection Lecture Seule (Viewer) : Si votre rôle est viewer, l'éditeur CodeMirror 6 est verrouillé et les modifications locales sont bloquées.
  • 📁 Prise en charge de l'Explorateur Windows / Linux : Vos ajouts et suppressions de fichiers effectués hors d'Obsidian sont synchronisés en direct et au démarrage.
  • 👥 Panneau Latéral des Collaborateurs : Onglet latéral affichant les membres connectés et liens directs vers leurs notes actives.
  • 📶 Indicateur de Latence : Affichage du ping en direct dans la barre d'état Obsidian.