Get up and running
Download and installation
- We provide two downloadable kits for you 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.
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.
- Extract the ZIP file in your server's web root
- Visit your new Kirby site in your browser at
yourdomain.com - Visit the Panel at
yourdomain.com/panel
Requirements
| Web server | PHP |
|---|---|
Any of the following:
|
|
The server OS must be POSIX compatible.
If you want to use PHP's built-in server (not recommended), you have to start it up with Kirby's router:
php -S localhost:8000 kirby/router.phpBrowsers 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 |
|---|---|
|
|
Alternative ways to install Kirby
There are alternative installation methods for advanced users who prefer to install and update Kirby using commands on the command line or in their version control tool. Check them out and use whichever method you prefer.
Installation guides for webhosts
Some providers have created dedicated guides how to install Kirby on their servers. If you are with one of these providers, keep on reading:
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.
- Open the Panel at
http://yourdomain.com/paneland log in. - Click on "Register" at the top.
- Enter your license code and your email address and press "Ok".
Without using the Panel
3.3.0If you don’t want the Panel to connect to our server, registration via the Panel fails, or you are not using the Panel at all, you can download your license files directly from our licenses website:
- Visit licenses.getkirby.com.
- Log in with the email you used when you purchased the license and any order number.
- In the list of your licenses, click on the key you want to register.
- Use the "Download license file" button to download the license file.
- Rename the downloaded file to
.license(without extensions). - Place it in the
/site/config/folder of your Kirby installation.
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:
Where to go from here
A tour around the house
Now that you have successfully installed Kirby on your server, it's time to explore your new Kirby installation. So get yourself a cup of coffee or tea (or whatever else you like most) and head over to the sections that interest you most or go on a tour to explore the Starterkit with us.
Guide
Our guide introduces you to every aspect of Kirby. From your first template to complex extensions. It should always be the starting point for your research.
Reference
Once you have familiarized yourself with the basics, the Reference is probably the number one resource you will keep getting back to. It's a reference of every method, option, helper, tag, root, url and more.
Kirby in a nutshell
Our "Kirby in a nutshell" recipe gives you a concise overview of how Kirby works, what to keep in mind when you start your project with Kirby, what questions you might want to ask yourself and about possible approaches, no matter if you are completely new to web development, or if you come from other systems.
Cookbook
While our docs provide a deep dive into every feature and aspect of Kirby, our Cookbook is a collection of all sorts of solutions you can build with Kirby. Starting from simple things like menus to frontend authentication, headless CMS setups and more.
Find recipes in the Cookbook ›
Troubleshooting
If you encounter any problems, make sure to check our guide on some common pitfalls and how to solve them.
Forum
The community in the Kirby Forum is always there to help out whenever you get stuck. It's likely that someone already had the same problem, so using the search function might uncover a solution to your problem within seconds. If you can't find a helpful topic, drop us your question.