Kirby 5 Templates  ·  STstudio

Books — setup guide

Every publication becomes a real 3D object, built from three images and three numbers. This walks through installing the template and adding your first book. New to servers? The hosting guide starts from zero.

01 Add Kirby and try it on your computer

Never put a website online before? Start with the hosting guide. It goes from zero: hosting, upload, domain, HTTPS and the Kirby licence.

Unzip the download. What you get is the template: templates, snippets, blueprints, assets and the demo content. Kirby core is not in the zip. Kirby’s licence does not allow us to include it, so you add it yourself: download the free Kirby 5 Plainkit (on github.com/getkirby/plainkit/tags, the zip of the newest tag that starts with 5.), unzip it, and copy only its kirby folder in next to index.php. The template is built for Kirby 5, not Kirby 6. If you use Composer, composer install does the same and picks a 5.x release on its own.

Use PHP 8.4. Kirby 5 accepts PHP 8.2 to 8.5 and refuses 8.6 and newer. On a Mac with Homebrew, install it once with brew install php@8.4, then run this inside the folder and open localhost:8000:

"$(brew --prefix php@8.4)/bin/php" -S localhost:8000 router.php

Apps with buttons (Laravel Herd, MAMP; not yet tested with this template): hosting guide, step 3. No database, no build step, nothing to compile.

02 Make your Panel account

Open /panel on your own computer, for example localhost:8000/panel. On the first local setup, enter your email, choose a password and Panel language, then press Install to create the administrator. That account is stored in your own files, in site/accounts/. There is no service to sign up for.

The empty Kirby Panel first-install form, with Email, Password, Language and Install
Kirby 5’s shared first-install form, captured locally in Books with empty fields; use your own email, password and Panel language, then press Install.
The Kirby Panel sign-in screen after installation
After installation, return to this Log in screen with the account you created; it is not the first-install form.

Create the account on your computer. On a public server Kirby switches this first step off, with or without HTTPS, and shows “The panel installer is disabled on public servers by default”. Upload site/accounts/ with the rest, hidden files included, and log in on the live site with the same email and password. The other way, a temporary panel.install setting, is in the hosting guide, step 6.

Putting the site online: which host to choose (it must run PHP 8.4 with Apache and .htaccess; GitHub Pages and Netlify will not work), then upload everything inside the folder.

03 Find where the books live

Books live on the Site screen — the section labelled “Books”. Everything else on your site stays out of the way.

The Panel screen listing every book
The Books overview. Each card is one book; “Add” makes another. Drag the cards to reorder them. The 31 demo books fit on one page; the public ring still starts in a fresh random arrangement on each visit.

04 Add a book

Press Add, give it a title, and open it. These are the fields:

One book open in the Panel, showing its fields
One book. The three images on the right, the real millimetres on the left.
Title
The book’s name. Shown in the list view and when selected.
Cover
Front cover image. One file.
Back
Back cover image. One file.
Spine
Spine image. One file.
Dimensions
Width, Height and Spine in millimetres — the real ones. A 15 mm novel will look thin next to a 75 mm monograph, because the template builds the geometry from these numbers.
Credit
Optional. A short word shown next to the title in the list, e.g. Design.

Worth knowing. Use the actual print dimensions. The whole point of the template is that the shelf is to scale — guessing round numbers flattens the effect you paid for.

On Home → Books, Shared back cover fills in for books without a back of their own. Shared fore-edge and Shared top and bottom edge let you replace the default paper edges for the collection.

Open Home → SEO / Meta to edit the page’s meta title, description, Open Graph title, description and image, and optional canonical URL.

05 Look at the site

Press Save, then use the book’s status control to set it to Published. Only Published books appear on the ring; Draft books stay off it. Reload the site to see your book — there is no separate build step. When editing an already-published book, just save and reload.

Books running with its demo content
The result. The view turns slowly on its own; drag it to explore the upright books; select one in the scene or List to see its title and actual dimensions.

Colour. The page colour is one field on the Site screen — Background colour. Pick anything; the List button and the loading bar switch between a light and a dark look on their own, and each row of the index takes its cover's main colour with black or white text, so everything stays readable.

06 Replace the demo content

The books that came with the template are original work and yours to keep, reuse or delete. Delete them from the Panel like any other page once your own are in.

Kirby is a paid CMS: a public site needs a paid licence per site; see getkirby.com/buy for current prices. You buy it from Kirby, and it is not included with this template. Working on your own computer stays free for as long as you like. How to enter the licence: hosting guide, step 8.