Obsidian Live Syncinator Server

The Obsidian-Live-Syncinator-Server is the server of the plugin syncinator.

Setup

Create a .env:

JWT_SECRET=secret
STORAGE_DIR=./data
SQLITE_FILEPATH=./data/db.sqlite3

Start the docker container:

docker run --name obsidian-live-syncinator-server ghcr.io/hiimjako/obsidian-live-syncinator-server -p 8080:8080 --env-file .env

Note

The container uses WebSockets, so be sure to enable it if you run the service under reverse proxy.

Create a new Workspace

docker exec obsidian-live-syncinator-server ./cli -name "workspace-name" -pass "strong-pass" -db "./data/db.sqlite3"

Important

The db argument must be the same as SQLITE_FILEPATH env variable.

Docker compose example:

services:
  syncinator:
    container_name: obsidian-live-syncinator-server
    image: ghcr.io/hiimjako/obsidian-live-syncinator-server:main
    env_file: .env
    restart: always
    volumes:
        - data:/usr/src/data
    ports:
      - 8080:8080

volumes:
    data:

Development

Add new migration

GOOSE_DRIVER=sqlite GOOSE_MIGRATION_DIR=./internal/migration/migrations/ goose create new_migration_name sql

Disclaimer

This is recreational software provided as-is, without any warranty. While the plugin is functional, I do not assume any responsibility for potential data loss or other issues that may arise from its use. Always maintain backups of your important data before using any synchronization tools.

TODO

• Create cluster of servers
• Ad DST (deterministic simulation testing) to test chunks
• Add optional encryption to files