Synch

Synch auf Cloudflare selbst hosten

Erstellen Sie Ihren eigenen Synch-Server auf Cloudflare und verbinden Sie das Obsidian-Plugin damit.

Diese Anleitung führt Sie durch die Erstellung eines eigenen Synch-Servers auf einem kostenlosen Cloudflare-Konto und das Einfügen dieser Serveradresse in das Obsidian-Plugin. Über die Schaltfläche unten lässt Cloudflare den Großteil der Einrichtung für Sie vorbereiten.

Möchten Sie Cloudflare vollständig vermeiden und stattdessen auf eigener Hardware betreiben? Siehe die Self-Hosting-Anleitung für Docker oder systemd.

Deploy to Cloudflare

Vor dem Deployment

Sie können mit einem kostenlosen Cloudflare-Konto beginnen. Wenn Ihr Cloudflare-Konto neu ist, aktivieren Sie zuerst R2. Öffnen Sie im Cloudflare-Dashboard R2 Object Storage, hinterlegen Sie eine Zahlungskarte und schalten Sie R2 ein. Wenn Sie diesen Schritt überspringen, kann das Deployment fehlschlagen.

Cloudflare-Dashboard mit ausgewähltem R2 Object Storage

Die API bereitstellen

  1. Klicken Sie auf Deploy to Cloudflare.
  2. Melden Sie sich bei Cloudflare an und wählen Sie das Konto aus, das Sie verwenden möchten.
  3. Folgen Sie den Anweisungen, um Ihr GitHub-Konto mit Cloudflare zu verbinden.
  4. Wenn Sie den Secrets-Bildschirm erreichen, geben Sie diese drei Werte ein:
    • AUTH_ALLOWED_EMAILS - durch Kommas getrennte E-Mail-Adressen, die Konten erstellen dürfen, zum Beispiel you@example.com,family@example.com
    • BETTER_AUTH_SECRET
    • SYNC_TOKEN_SECRET
Secret-Werte erstellen

Klicken Sie auf die Schaltfläche und fügen Sie jeden Wert in das gleichnamige Cloudflare-Feld ein.

  1. Klicken Sie auf Deploy, um zu starten, und warten Sie, bis das Deployment abgeschlossen ist.

Deploy-to-Cloudflare-Formular mit den erforderlichen Secret-Feldern

Obsidian verbinden

Nach dem Deployment kopieren Sie Ihre Synch-Serveradresse aus dem Tab Settings des Cloudflare Workers. Sie sieht in der Regel so aus:

https://your-synch-api.your-account.workers.dev

Bereich Domains and Routes des Cloudflare Workers mit sichtbarer workers.dev-URL

  1. Öffnen Sie Obsidian.
  2. Gehen Sie zu Settings.
  3. Öffnen Sie Synch.
  4. Fügen Sie unter Self-hosted server die kopierte Synch-Serveradresse ein. Fügen Sie kein abschließendes / hinzu.
  5. Klicken Sie auf Save.
  6. Fahren Sie anschließend wie gewohnt mit der Anmeldung und der Vault-Einrichtung fort.

Ihren Server aktualisieren

Aktivieren Sie dies nur, wenn Sie Ihren Server später einfach aktualisieren möchten. Die Einrichtung ist nur einmal erforderlich.

Serveraktualisierung einrichten (optional)
Server-Updates aktivieren

Fügen Sie die URL Ihres Deployment-Repositorys ein und klicken Sie auf die Schaltfläche unten.

  1. Verwenden Sie den Initialisierer oben und committen Sie den vorausgefüllten Workflow auf GitHub.
  2. Gehen Sie zum Tab Actions des Repositorys.
  3. Führen Sie den Workflow Update Synch server aus, wann immer Sie aktualisieren möchten.

Cloudflare erstellt Ihren Server anschließend automatisch neu und stellt ihn erneut bereit. Ihre Secrets und Daten bleiben unberührt, von Ihnen selbst committete Änderungen (außer wrangler.jsonc und Workflow-Dateien) werden jedoch überschrieben. Wenn die Zusammenfassung des Laufs Einträge unter Manual attention needed auflistet, folgen Sie den dortigen Anweisungen.