Skip to content

Kirby 5.0.4

Site blueprint

The Site blueprint is located in /site/blueprints and controls the Panel setup and form fields for the site/dashboard.

Blueprint location

  • /site/blueprints/site.yml

Title

With the title option, you can overwrite the Site label in the main menu of the Panel.

Translated titles

The title can be translated by passing an array of translations with the matching language code as key:

title:
  en: Site
  de: Webseite

Options

With options, you can control all the site actions that should or should not be available.

Option Value
changeTitle true/false
update true/false

Each option can be set on a per user role for fine-grained permissions, for example:

options:
  delete:
    admin: true
    editor: false

Or using a wildcard to change the default for all roles:

options:
  update:
    *: false
    editor: true

Controlling accessibility for roles.

# Page is not accessible and not visible for all roles except admins.
options:
  access:
    *: false
    admin: true
  list:
    *: false
    admin: true

Custom preview URL

You can set the preview URL for the site in the site.yml with the preview property:

title: Site

options:
  preview: https://mycustomdomain.com
Since 5.0.0

View buttons

Kirby allows you to define what buttons to use for this site. To select which (default) buttons to show on a particular view you can set the buttons option in the corresponding blueprint:

buttons:
  settings: true

By setting the value to true, you can reference existing buttons (from the core or config.php file or even Panel area plugin extensions) by name and decide which ones to include and in what order.

Create a new button

You can now also define your own custom buttons directly in a blueprint:

buttons:
  settings: true
  social:
    icon: mastodon
    text: Mastodon
    link: "https://mastodon.social/@getkirby"
    theme: purple-icon

The available options are based on the k-view-button component. Check out the config option documentation for more details, e.g. in regard to available attributes or query support.

Disable all buttons

buttons: false