Installation

Drop-in installation with zero-config defaults – adds a KQL endpoint without affecting existing routes.

Install the Plugin

Composer

The recommended way to install the plugin:

composer require johannschopplich/kirby-headless

ZIP File Download

Download the latest release or head over to the releases page to see all versions. Extract the ZIP file to your site/plugins folder.

The plugin works out of the box without additional configuration. By default:

KQL endpoint available at /api/kql, protected by Kirby's native API authentication (bearer token auth is opt-in)
Existing routes and templates remain unaffected until you enable global routes

Customize the plugin behavior with these options:

Introduction

Use Kirby as a backend for frontend apps, static site generators, or mobile apps – bearer token auth, KQL enhancements, and JSON templates included.

Authentication

Lock the headless KQL endpoint and global routes behind a bearer token, or fall back to Kirby's native API authentication.