Skip to content

Kirby

The Orimora Sync Kirby plugin imports the published documents of a shared folder into Kirby pages, following the same browse-import (pull) pattern as the WordPress plugin: a read-only folder-share token authenticates read-only calls to Orimora, and you map each Orimora collection to a Kirby parent page + template. Orimora stays the source; the Kirby-specific knowledge (field format, escaping) lives in the plugin.

Orimora ──Pull-API (Bearer kb_…)──▶ Kirby plugin ──▶ Kirby pages
(source) (adapter)
  1. In Orimora, share a collection (collection menu → “Connect to a service”, target CMS) to mint a read-only, published-only token (kb_…).

  2. In Kirby, open Orimora in the Panel and enter the URL + folder-share token under Connection, then Save connection. The token is stored under site/orimora/; it is write-only and never shown again.

    For a hardened setup, set the connection in site/config/config.php instead. These values take precedence and keep the secret out of site/orimora/:

    return [
    'orimora.sync.url' => 'https://wiki.example.com',
    'orimora.sync.token' => 'kb_…',
    'orimora.sync.routeKey' => '…random…', // optional: enables the cron route
    ];
  3. Under Mapping, each shared collection gets a row: choose its Kirby parent page + template + status, then Save mapping. Leave a collection on skip to not import it. The target parent pages and templates must already exist in your Kirby site.

  4. Under Browse & import, load the documents, tick the ones you want and Import selected. Each becomes a page under its mapped parent. A badge marks each document as new, imported or newer version. Images are downloaded into the page and rewritten to Kirby (image: …) tags.

  5. Refresh imported re-pulls title + body of the pages you already imported. It never imports new documents and never unlists anything: a document removed or unpublished in Orimora simply stops being refreshed, and its page stays as you left it. This is curation, not a mirror.

Keeps already-imported pages up to date (title + body). It does not import new documents; that stays a deliberate browse-and-pick action. Either the Kirby CLI command:

Terminal window
kirby orimora:sync

or the secret-gated route (after setting orimora.sync.routeKey):

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

Imported documents keep their mermaid code blocks, and the plugin rewrites them into the markup the Mermaid library renders. Rendering is opt-in: you self-host the library and include one snippet in your layout. The steps are in the plugin README.

Clone the orimora-kirby-importer repository into site/plugins/orimora-sync (or clone it elsewhere and symlink it there):

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

The built Panel asset is committed, so it works as-is — no build or composer install needed to run it.

  • The token is set either in the Panel (stored under site/orimora/, write-only, never shown again) or, for hardened setups, in config.php, which takes precedence. If you use the Panel, keep site/orimora/ out of version control. The Panel only ever sees whether a connection is configured, never the token itself.
  • The trust boundary is outbound: the plugin only calls Orimora with the read-only, published-only token. It can neither write to Orimora nor expose drafts.
  • Field-separator safety. Content is written through Kirby’s Page API, whose serializer escapes the ---- field separator automatically — a Markdown body containing ---- (thematic breaks, tables, Setext headings) can never inject foreign Kirby fields (the class of advisory GHSA-x5mr-p6v4-wp93).
  • Panel API routes are guarded by Kirby (an authenticated Panel user); the cron route by a timing-safe key comparison.

Unlike the WordPress plugin — where the CMS owns slug/status/SEO — here Orimora owns title + body and a refresh overwrites them. Tell your editors that body edits in Kirby do not survive a refresh.

  • Flat tree: a folder’s documents land at one level under the parent (nesting is planned).
  • Full pull on refresh: a refresh re-pulls the whole shared set, not only changed documents.
  • One folder share per site.