Installation

Install and configure the Kirby Headless plugin.

Install the Plugin

Composer

The recommended installation method is via Composer:

composer require johannschopplich/kirby-headless

Download

Download the latest version from the releases page and extract to your site/plugins folder:

site/plugins/
├─ kirby-headless/
│  └─ … Plugin files

Default Behavior

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

KQL endpoint available at /api/kql with bearer token authentication
CORS preflight requests handled automatically
Existing routes and templates remain unaffected

Kirby Headless does not interfere with Kirby's default routing unless you enable global routes. Your existing templates and routes continue to work as expected.

Configuration

Customize the plugin behavior with these options:

Authentication – Bearer token or basic auth
CORS – Cross-origin request settings
Panel – Preview URLs and redirects

Introduction

Headless CMS capabilities for Kirby with bearer token auth, KQL enhancements, and JSON templates.

Authentication

Configure bearer token or basic authentication for your headless API.