Configuring Kirby

The config.php

General Kirby configuration settings, configuration settings for plugins as well as custom configuration settings go into /site/config/config.php. The config file contains a return statement with an array of config options:

<?php

return [
    'debug'            => true,
    'someOtherSetting' => 'something'
];

Make sure to only use a single return statement in your config.php file (with all your options defined in that one return array).

Plugin options

You can also set options for your installed plugins in the site/config/config.php:

<?php

return [
    'author.pluginname' => [
        'option' => 'a custom value',
        'another-option' => [
            'with-a-nested-option' => 'also a custom value'
        ]
    ]
];

<?php

return [
    'author' => [
        'pluginname' => [
            'option' => 'a custom value',
            'another-option' => [
                'with-a-nested-option' => 'also a custom value'
            ]
        ]
    ]
];

Using multiple config files

If you want to keep your config.php clean when using more complex options, you can outsource them to individual files that you require in the return array:

return [
  'debug' => true,
  'hooks' => require_once 'hooks.php'
];

return [
  // your hooks
];

Using options

Config options can be used anywhere in Kirby with the $kirby->option() method:

$kirby->option('someOtherSetting');

Or with the option helper:

option('someOtherSetting');

You can use dot notation to access nested config options:

return [
    'my' => [
        'option' => 'foo'
    ]
];

$kirby->option('my.option')

Fallbacks

You can pass option fallbacks as second parameter in the option methods. This can be useful if a option does not necessarily have to be set in the config file.

$kirby->option('someOtherSetting', 'my fallback');
option('someOtherOption', 'my fallback');

All configuration options

Hooks and Routes

You can register hooks or routes in your config.php if you don't want to create a plugin for them.

<?php

return [
  'hooks' => [
    // the hooks definition goes here…
  ],
  'routes' => [
    // the routes definition goes here…
  ]
];

All hooks

Base URL setup

By default, Kirby detects the base URL of your installation from the server configuration. This base URL is then used to generate all resource URLs and links on your site and in the Panel.

If your URLs are incorrect, this may be because of a reverse proxy that sits in between the client and Kirby. For security reasons, the reverse proxy configuration is only respected if you explicitly configure a fixed base URL or a set of possible base URLs with the url option:

<?php

return [
  'url' => [
    'https://example.com',
    'https://staging.example.com',
    'http://example.test'
  ]
];

You can read more in the reference.

Multi-environment setup

You can set different options based on the domain by adding additional config files containing the domain.

Example setup

By setting different options in those config files, you get a very flexible system that can be deployed to different servers and react to the current environment accordingly.

CLI configuration

If you are using Kirby with a command-line interface (or CLI for short), for example with the Kirby CLI or with a custom script, you can define specific config overrides in a separate file:

The CLI-specific config file works like a host-specific config file in that it can override anything you put into your standard config.php.

Deployment configuration

There is another optional config file that overrides any option value, no matter if it was set in config.php or a host-specific config file:

You can use this file for dynamic option values that are set during a deployment, e.g. a specific fixed url value for that server, randomly generated deployment IDs or sensitive data like API keys.

Panel configuration

The Panel has additional configuration options to include custom CSS and JS files, to move it to a different subfolder or to switch it off entirely.