Authentication

Nuxt Kirby supports multiple authentication methods to work with different Kirby setups. Choose the method that best fits your project requirements.

TIP

For new projects, we recommend using token-based authentication with the Kirby Headless plugin. It includes secure token-based authentication and a custom KQL endpoint api/kql that works out of the box with any Kirby installation.

Overview

Method	Use Case	Security	Setup Complexity
Bearer Token	Production, Kirby Headless	High ✅	Easy
Basic Auth	Development, existing Kirby	Medium ⚠️	Medium
None	Public APIs, read-only	Low ❌	Minimal

Token-Based Authentication

Nuxt Kirby supports the use of a bearer token for authentication when coupled with the Kirby Headless plugin. It supports KQL with token authentication out of the box, unlike the default Kirby API which requires basic authentication for API endpoints.

Enable token-based authentication in your Nuxt project's nuxt.config.ts file:

// `nuxt.config.ts`
export default defineNuxtConfig({
  modules: ['nuxt-kirby'],

  kirby: {
    // Enable token-based authentication for the Kirby Headless plugin,
    // which includes a custom KQL endpoint `api/kql`
    auth: 'bearer'
  }
})

Set the following environment variables in your project's .env file:

KIRBY_BASE_URL=https://kirby.example.com
KIRBY_API_TOKEN=your-token

INFO

Ensure that you set the same token as the KIRBY_HEADLESS_API_TOKEN environment variable in the .env file of your headless Kirby project.

Basic Authentication

If you do not want to build your KQL API using Kirby Headless plugin, you can use basic authentication. However, this method is not recommended for production environments due to security concerns.

TIP

The default KQL endpoint /api/query requires authentication. You have to enable HTTP basic authentication in your Kirby project's config.php file:

// `site/config/config.php`
return [
    'api' => [
        'basicAuth' => true,
        'allowInsecure' => true // For local development, you may want to disable SSL verification
    ]
];

Nuxt Kirby will automatically read your environment variables. Create an .env file in your project (or edit the existing one) and add the following environment variables:

KIRBY_BASE_URL=https://kirby.example.com
KIRBY_API_USERNAME=your-username
KIRBY_API_PASSWORD=your-password

TIP

Nuxt Kirby uses basic authentication by default, so you do not need to set the auth option in your nuxt.config.ts file.