Guide

• Get up and running

  All you need to know to get Kirby up and running: Installation, requirements and updates.

• About the docs

  A quick overview on the different parts of the documentation

• Exploring the Starterkit

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

• Content

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

• Files

  All about working with files in Kirby: images, videos, documents, responsive images, thumbnails…

• 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.

• Page builder

  Create rich content or even complete page layouts right from the Panel

• Unique IDs & Permalinks

  Build persistent relations between pages, files or users

• 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.

• Configuration

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

• Authentication & Sessions

  Configure how users log in to the Panel and how Kirby remembers state between requests.

• Routing

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

• Caching

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

• Emails

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

• Plugins

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

• Database

  Connect to a database and query results.

• 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.

• Security

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

• Beyond Kirby

  Learn about the different ways to use Kirby as a content source for other tools and systems.

• Troubleshooting

  We try to make using Kirby 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.