Obsidian Plugin

import { Aside } from ‘@astrojs/starlight/components’;

Das Orimora Obsidian Plugin (obsidian/) ermöglicht die Synchronisation zwischen deinem lokalen Obsidian-Vault und einer Orimora-Instanz.

Installation

Das Plugin ist noch nicht im Obsidian Community Plugins-Verzeichnis veröffentlicht. Manuelle Installation:

cd obsidian
yarn install
yarn build

# In deinen Obsidian-Vault-Plugins-Ordner kopieren
cp manifest.json main.js <vault>/.obsidian/plugins/orimora-sync/

Aktiviere das Plugin unter Obsidian → Einstellungen → Community Plugins.

Konfiguration

Einstellung	Beschreibung
Orimora URL	Basis-URL deiner Orimora-Instanz, z.B. `https://wiki.example.com`
API Key	Ein `kb_`-API-Schlüssel aus Einstellungen → Entwickler
Standard-Sammlung	Sammlung, in die Dokumente gepusht werden
Pull-Ordner	Vault-relativer Ordner für gepullte Dokumente (Standard: `Orimora`)
Pull-Sammlung	Sammlung, aus der gepullt wird (Standard: Standard-Sammlung)

Push

Sende eine einzelne Notiz oder einen ganzen Ordner an Orimora.

Befehl	Aktion
`Push active file to Orimora`	Aktuelle Notiz pushen
`Push folder to Orimora`	Alle `.md`-Dateien im aktiven Ordner pushen

Rechtsklick auf eine Datei oder einen Ordner für die gleichen Optionen.

Nach erfolgreichem Push erhält die Notiz Orimora-Frontmatter:

---
orimora_id: <document-uuid>
orimora_collection_id: <collection-uuid>
orimora_last_synced: 2025-01-01T12:00:00.000Z
---

Pull

Zwei Pull-Modi stehen zur Verfügung:

Inkrementeller Pull (empfohlen)

Holt nur Dokumente, die seit orimora_last_synced geändert wurden. Beim ersten Lauf wird automatisch auf einen vollständigen ZIP-Snapshot zurückgefallen.

Befehl: Pull changed documents from Orimora (incremental)
Ribbon: Klick auf das ↓-Symbol

Vollständiger ZIP-Snapshot

Lädt die gesamte Sammlung als ZIP-Archiv und überschreibt alle lokalen Dateien.

Befehl: Pull collection from Orimora (ZIP snapshot)

Konfliktbehandlung

Push-Konflikte

Wenn ein Dokument mit gleichem Titel bereits in Orimora existiert, bietet das Plugin drei Optionen:

Überschreiben — Bestehendes Dokument aktualisieren
Duplizieren — Neues Dokument mit anderem Titel erstellen
Abbrechen — Push für diese Datei abbrechen

Pull-Konflikte (Lokal-neuer-Erkennung)

Beim inkrementellen Pull prüft das Plugin, ob eine lokale Datei seit dem letzten Sync bearbeitet wurde. Wenn die lokale Datei neuer ist als sowohl der orimora_last_synced-Zeitstempel als auch das Remote-updatedAt, wird die lokale Datei übersprungen, um lokale Änderungen nicht zu überschreiben.

Übersprungene Dateien werden in der Pull-Zusammenfassung mit einem ⏭-Indikator angezeigt.

Wiki-Links

[[WikiLinks]] werden anhand des orimora_id-Frontmatters der Vault-Dateien aufgelöst und in korrekte Hyperlinks in Orimora umgewandelt. Beim Pull werden Orimora-Dokumentlinks zurück in [[WikiLinks]] konvertiert.

API-Anforderungen

Das Obsidian Plugin nutzt die Orimora REST API:

Endpunkt	Verwendung
`GET /api/v1/collections`	Sammlungsliste laden
`GET /api/v1/documents?collectionId=X&updatedSince=ISO&format=markdown`	Inkrementeller Pull
`GET /api/collections.export?id=X&format=zip`	Vollständiger ZIP-Pull
`POST /api/documents.create`	Neue Dokumente pushen
`POST /api/documents.update`	Updates pushen

API-Keys mit Lesen-Berechtigung reichen für Pull. Lesen + Schreiben wird für Push benötigt.