Skip to content

Installation & Updates

Kirby is designed with ease of use and only simple hardware and software requirements in mind. You can run Kirby in many different local development environments, as well as on most shared hosting platforms, VPS or dedicated servers.

Requirements

Web server PHP
Any of the following:
  • Apache 2
  • Nginx
  • LiteSpeed
  • Caddy
  • PHP 7.1+
  • mbstring extension
  • curl extension
  • ctype extension
  • gdlib extension

Browsers for the Panel

Kirby does not modify the output of your site's templates and thus has no effect on its browser requirements. The Panel is built on modern browser features though and has a couple browser requirements which need to be met by your site's editors.

Desktop Mobile
  • Chrome 57+
  • Firefox 54+
  • Safari 10.1+
  • Edge 16+
  • Opera 44+
  • Mobile Safari 10.3+
  • Android Browser 67+
  • Chrome for Android 70+

Other browsers will very likely be compatible as soon as they support CSS Grid and the JS fetch API. The Panel will check for those requirements.

Installation

Kirby has two downloadable versions to get started with:

Starterkit

The Starterkit is a full-blown Kirby installation with a lot of example content, blueprints, templates and more. It is ideal to explore many of Kirby's options and play with the Panel.

Download Starterkit

Plainkit

The Plainkit is a minimal Kirby installation with the basics you need to start a project from scratch. It is the ideal choice if you are already familiar with Kirby or if you want to start step-by-step.

Download Plainkit

Unzip the ZIP archive in the web root of your web server (or copy all unzipped files into the web root in case the archive unzipped itself).

Alternative ways to install Kirby

There are alternative installation methods for advanced users who prefer to install and update Kirby using simple commands on the command line or in their version control tool:

Check them out and use whichever method you prefer.

Create your first account

Kirby's control panel (aka. the Panel) comes without any pre-installed accounts. Open http://yourdomain.com/panel in the browser to start the installer and create the first account.

Register your installation

Once you publish your website, you need to purchase a Kirby license. We will send you a unique license code for your domain. You can register your installation with the following steps.

  1. Open the Panel at http://yourdomain.com/panel and log in.
  2. Click on "Register" at the top.
  3. Enter your license code and your email address and press "Ok".

Updates

To update Kirby, download the latest version and replace the kirby folder.

That's it! Because Kirby does not use a database by default, you don't have to run any database migrations.

Updating Kirby with the advanced methods

If you used one of the advanced installation methods, you can also use them to update Kirby:

Troubleshooting

In an ideal world, everything went well and you don't need this section.

If you run into unexpected issues after an update, first try if deleting the media and /site/cache folders helps. If you still run into any issues, check out our Troubleshooting guide.