Guide

Get started

• Quickstart

  Long guides are boring. Get Kirby up and running in 1 minute.

• Tour

  Take a tour around the house and we'll give you a quick look at every part of Kirby.

• Installation & Updates

  Install Kirby the way that fits your needs, start from scratch or from a full blown Starterkit.

Get productive

• Content

  Learn how to create pages and how to fill them with content.

• Templates

  How to use Kirby's template system and API to build any kind of template.

• Blueprints

  How to create forms for the Panel and access blueprints on the frontend.

• Languages

  How to set up and work with multi-language websites and how to translate templates.

• Users

  Learn everything about Kirby's user management and permissions.

Get advanced

• Virtual pages

  In Kirby, you can integrate data from any data source and use them as if they were real Kirby pages, including creating and editing their content in the Panel.

• API

  The Rest API offers full access to all data within Kirby and can be used by your future app built on top of Kirby.

• Configuration

  Almost every aspect of Kirby can be controlled and configured to do exactly what you need it to do.

• Plugins

  Kirby starts simple, but it can handle highly advanced setups and solutions, by providing tools, such as a router, hooks, controllers and more.

• Emails

  How to use built-in classes and helpers to send emails from within Kirby.

• Caching

  Use Kirby's page cache or set up your own cache wherever you need it.

• Routing

  Use Kirby's router to modify URLs or provide extra functionality when the user calls an given URI pattern.

• Sessions

  Configuring Kirby's session and using it for your own data.

• Security

  Learn about how to secure your Kirby installation on your server.

• Database

  Connecting to a database and querying results

• Troubleshooting

  We try to make the installation and configuration as straight forward as possible. But sometimes you just get stuck and we want to help you out of it as fast as possible.

• Kirby & Privacy

  Things you need to know about Kirby in terms of privacy and GDPR compliance.