Kirby 5 Templates  ·  STstudio

Library — setup guide

Each book is one spine image and one number — add covers, a description and links when you like. Physics does the rest. 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 under the Library page, split into Drafts, In Review and Published. Only Published books appear on the shelf.

The Panel screen listing every book
The Library page. Drag the rows to reorder the detail list; the dot on the right is the status. The physical shelf still starts in a new 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 Kirby Panel: spine, front cover and back cover images on the left; title, author, spine height, description and two links on the right
One book: its images on the left — spine, front cover, back cover — and its words on the right: title, author, height, description and links.
Spine image
One image of the spine only — not the cover. Its aspect ratio is preserved, so a thick book reads thick.
Front cover image
Optional. The face of the 3D book when it is taken off the shelf, and shown on the book’s own page. Its proportions set the book’s width.
Back cover image
Optional. The other side of the 3D book, and shown on the book’s own page.
Title
Used for the generated fallback spine, the details beside the 3D book, and for accessibility.
Author
Optional. Shown under the title.
Spine height (mm)
Relative height on the shelf. The tallest book in your set fills 90% of the screen; everything else scales against it.
Description
A few sentences shown beside the book and on its page. Plain text; an empty line starts a new paragraph.
Links
Optional. A link text and a web address per row — publisher, excerpt, shop. Each opens in a new tab.

Worth knowing. A book with no spine image still works — the template generates a Swiss-style spine from the title, so the shelf never looks half-built while you are still uploading. A book with no cover image gets a plain cover in its spine’s colour.

Open Library → 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 shelf; Drafts and In Review 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.

Library running with its demo content
The result. Spines fall in, settle, and can be thrown.

Click a spine — the pointer shows it can be picked; a drag still throws it — and the book slides off the shelf, turns and becomes a 3D book with its details beside it. Drag the book to turn it, or press Back cover. Esc, Close or a click beside it puts it back. A title in Book details scrolls the shelf to that book and takes it out the same way.

A book taken off the shelf: the 3D book Clockmaker, turned slightly, with its title, author, description, two links and a Back cover button beside it
A book off the shelf. Its title, author, description and links are the fields from step 04.

Colour. The page colour is one field on the Site screen — Background colour. Pick anything; text and buttons switch between a light and a dark look on their own.

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.