Zum Inhalt springen

Kirby

Das Orimora-Sync-Kirby-Plugin importiert die veröffentlichten Dokumente einer Ordnerfreigabe in Kirby-Pages — nach demselben Browse-Import-(Pull-)Muster wie das WordPress-Plugin: ein nur-lesendes Ordnerfreigabe-Token authentifiziert nur-lesende Aufrufe an Orimora, und du mappst jede Orimora-Kollektion auf eine Kirby-Parent-Page + ein Template. Orimora bleibt die Quelle; das Kirby-spezifische Wissen (Feldformat, Escaping) lebt im Plugin.

Orimora ──Pull-API (Bearer kb_…)──▶ Kirby-Plugin ──▶ Kirby-Pages
(Quelle) (Adapter)
  1. Gib in Orimora eine Kollektion frei (Kollektions-Menü → „Mit einem Dienst verbinden”, Ziel CMS), um ein nur-lesendes, nur-veröffentlichtes Token (kb_…) zu erzeugen.

  2. Öffne in Kirby im Panel Orimora, trage unter Verbindung die URL + das Ordnerfreigabe-Token ein und klicke Verbindung speichern. Das Token wird unter site/orimora/ gespeichert; es ist nur schreibbar und wird nie wieder angezeigt.

    Für ein gehärtetes Setup trägst du die Verbindung stattdessen in site/config/config.php ein. Diese Werte haben Vorrang und halten das Secret aus site/orimora/ heraus:

    return [
    'orimora.sync.url' => 'https://wiki.example.com',
    'orimora.sync.token' => 'kb_…',
    'orimora.sync.routeKey' => '…zufall…', // optional: aktiviert die Cron-Route
    ];
  3. Unter Mapping bekommt jede freigegebene Kollektion eine Zeile: wähle ihre Kirby-Elternseite + Template + Status und klicke Mapping speichern. Lass eine Kollektion auf überspringen, um sie nicht zu importieren. Die Ziel-Elternseiten und -Templates müssen in deiner Kirby-Site bereits existieren.

  4. Unter Durchsuchen & importieren lädst du die Dokumente, wählst die gewünschten aus und klickst Auswahl importieren. Jedes wird eine Page unter seiner gemappten Elternseite. Ein Badge kennzeichnet jedes Dokument als neu, importiert oder neuere Version. Bilder werden in die Page heruntergeladen und auf Kirby-(image: …)-Tags umgeschrieben.

  5. Importierte aktualisieren holt Titel + Body der bereits importierten Pages neu. Es importiert nie neue Dokumente und setzt nichts auf unlisted: ein in Orimora entferntes oder unveröffentlichtes Dokument wird schlicht nicht mehr aktualisiert, seine Page bleibt, wie du sie hinterlassen hast. Das ist Kuration, kein Spiegel.

Hält bereits importierte Pages aktuell (Titel + Body). Neue Dokumente werden dabei nicht importiert; das bleibt eine bewusste Auswahl im Panel. Entweder der Kirby-CLI-Command:

Terminal-Fenster
kirby orimora:sync

oder die secret-geschützte Route (nach Setzen von orimora.sync.routeKey):

Terminal-Fenster
curl -fsS "https://deine-site.example/orimora/sync?key=<routeKey>"

Importierte Dokumente behalten ihre mermaid-Codeblöcke, und das Plugin schreibt sie in das Markup um, das die Mermaid-Bibliothek rendert. Das Rendern ist Opt-in: du hostest die Bibliothek selbst und bindest ein Snippet in dein Layout ein. Die Schritte stehen in der Plugin-README.

Klone das Repository orimora-kirby-importer nach site/plugins/orimora-sync (oder klone es woanders und symlinke es dorthin):

Terminal-Fenster
git clone https://github.com/Orimora-app/orimora-kirby-importer site/plugins/orimora-sync

Das gebaute Panel-Asset ist mit-committet, es läuft also direkt — kein Build und kein composer install zum Betrieb nötig.

  • Das Token wird entweder im Panel gesetzt (gespeichert unter site/orimora/, nur schreibbar, nie wieder angezeigt) oder, für gehärtete Setups, in config.php, die Vorrang hat. Nutzt du das Panel, halte site/orimora/ aus der Versionskontrolle heraus. Die Panel-UI sieht nur, ob eine Verbindung konfiguriert ist, nie das Token selbst.
  • Die Vertrauensgrenze ist ausgehend: das Plugin ruft Orimora nur mit dem nur-lesenden, nur-veröffentlichten Token. Es kann weder nach Orimora schreiben noch Entwürfe offenlegen.
  • Separator-Sicherheit. Inhalte werden über die Kirby Page-API geschrieben, deren Serializer den Feld-Separator ---- automatisch escaped — ein Markdown-Body mit ---- (Thematic Breaks, Tabellen, Setext-Überschriften) kann keine fremden Kirby-Felder injizieren (Klasse der Advisory GHSA-x5mr-p6v4-wp93).
  • Panel-API-Routen sind durch Kirbys Auth geschützt; die Cron-Route durch einen timing-sicheren Schlüsselvergleich.

Anders als beim WordPress-Plugin — wo das CMS Slug/Status/SEO besitzt — besitzt hier Orimora Titel + Body, und eine Aktualisierung überschreibt sie. Sag deinen Redakteuren, dass Body-Änderungen in Kirby eine Aktualisierung nicht überleben.

  • Flacher Baum: die Dokumente eines Ordners landen auf einer Ebene unter der Elternseite (Verschachtelung ist geplant).
  • Voller Pull bei jeder Aktualisierung: es wird die gesamte Freigabe neu geholt, nicht nur geänderte Dokumente.
  • Eine Ordnerfreigabe pro Site.