Kirby 5 Templates  ·  STstudio

Map — setup guide

Each node is a page. The lines between them are a field you fill in. This walks through installing the template and adding your first node. 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
The empty local Kirby 5 installation form: Email, Password, Language and Install. This GIF presents the captured form, not an account being created.
The empty Kirby Panel sign-in form used after installation
After installation, return to this Log in screen with the account you created. The captured form is empty; no credentials are entered in this example.

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 nodes live

Nodes are top-level pages, listed on the Site screen. Decorative markers — small labelled icons placed by x/y position — live on the Home page instead.

Captured CMS states showing Colour mode, the Map Nodes list and the empty Add node dialog
The Site screen, a scroll through Map Nodes, then the empty Add dialog. Each node is a page; Add opens the form for a new draft.

04 Add a node

Press Add, give the node a Title, check its URL appendix and choose Create as Draft. Open the draft to fill these fields:

Captured Main Gate editing states showing Logo, Links, Text, Projects, Target Node choices and the status dialog
Recorded CMS states for Main Gate: its fields, text and projects, the Target Node selector, then the status dialog. Connections draw the lines between nodes.
Title
The label under the node on the map.
Logo
The node’s image. SVG or PNG; transparent backgrounds look best.
Links
Title and URL pairs. They become buttons in the side panel.
Text
Shown in the side panel when a visitor clicks the node.
Projects
Optional. A title, a short description and a URL per row, listed in the side panel.
Connections
Pick the other nodes this one links to. Each pick draws one hand-sketched line. Enter nothing and no lines are drawn — the shape of the map is entirely yours.

Worth knowing. Connections are one-directional in the field but drawn once on the map. Set them on whichever node you think of first; you do not need to mirror them.

On Home → Content, edit About Text (primary) and optional About Text (secondary). On Home → Markers, set each marker’s Icon, Label, X (%) and Y (%) for the shared starting positions.

The front-end Edit Markers button is available only while signed in. Dragging there saves positions in that browser’s local storage, not in the CMS; change Home → Markers in the Panel to set them for visitors.

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

05 Save, choose a colour mode and look at the site

Press Save and move any new Draft node to a public status before reloading the site. Both Listed and Unlisted map-node pages are included in the map; Drafts are not. After editing a public node, just save and reload — the map reads the content files, with no separate build step.

Open Site → Colour mode. White is the starting setting, with black pictograms, text and lines on white. Choose Black for a black map with a light interface, or Custom colour to reveal the Background colour picker. Press Save and reload the map to see the change.

Recorded CMS selection and Save states: White, Black, then White again
Captured Colour mode states: White, select Black and save, then select White and save. This setting changes the visitor-facing map; the Panel’s dark editor appearance is separate.

On the site, drag a node and the whole network reacts; click one to open its image, links, text and projects.

Node images. The saved Invert node images on dark backgrounds preference is kept when modes change. With Yes, black pictograms turn white on Black mode or a dark custom colour; choose No for full-colour images. White mode does not invert the images. Existing sites without a stored Colour mode keep their previous custom background.

06 Replace the demo content

The download contains one starting map: a black-and-white Zoo with twelve nodes. In the Panel, edit those nodes or add your own pages, images, text and connections. Keep a backup of content/ before making large changes.

The product details show Zoo, Store and Garden as three possible uses of the same template. Store and Garden are separate presentation examples, not extra datasets in the download. Your installed site has one map, without the demo's three-map navigation.

The nodes 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.