Skip to content

Knowledgebase

Installing Kirby and checking the first setup

development

Kirby is a file-based CMS with templates, content files and a browser editor. This guide helps you check hosting compatibility, choose an appropriate installation method and verify the first usable site. The application, its extensions and any commercial license remain separate from the hosting account.

01 Check Kirby and hosting requirements

Check the current Kirby requirements and the production licensing terms. An available installation package does not itself grant a commercial site license or licenses for paid plugins.

Use the project's current supported release information and the requirements shown for the package you select. If Softaculous offers an older or unsuitable build, follow the current vendor installation process or ask us to confirm a suitable environment. Do not enable an unsupported PHP runtime simply to reproduce an old tutorial.

02 Install Kirby in the correct location

  1. Back up any existing site at the destination. Choose an empty directory or a separate staging hostname for a new installation; never approve overwriting a working site without a migration plan.
  2. Open Softaculous where your hosting service includes it. In cPanel, search for Softaculous Apps Installer. In SiteWorx, use Hosting Features > Softaculous where that integration is enabled.
  3. Find Kirby and review the package and requirements before selecting Install. Select the correct HTTPS domain. Leave In Directory empty only when the empty domain root is the intended destination.
  4. Complete the application-specific fields and a strong administrator credential stored in a password manager. Supply a reachable administrative email where requested. Review file-backup and update choices. This file-based CMS requires its content, media and configuration files in the recovery plan; a database-only export is not sufficient.
  5. Start installation once and wait for the completion result. Record the public and administration URLs. Where this application needs the publisher's own deployment process, complete that process instead of forcing an outdated installer package.

03 Configure Kirby for first use

Use a current trusted package and configure the site URL, content structure and editor access. Review the documented writable paths and keep private configuration outside public downloads.

04 Example: deploy templates without losing live editorial changes

Suppose an editor updates a service page and uploads a new image in the live Kirby panel while a developer prepares a template change locally. A complete upload of the developer's older project can overwrite the editor's newer file-based content.

  1. Back up the live content and media before the deployment.
  2. Identify which files belong to the reviewed code change and which are live editorial data.
  3. Deploy the intended code through your agreed process, preserving or deliberately reconciling the newer content.
  4. Check that the updated template renders both the new text and uploaded image, and that the editor can still save a change.

Test that same separation in staging. A successful code upload is incomplete if it silently replaces newer content with an old copy.

Confirm the expected result

Create a page and upload an image using a limited editor. Check front-end rendering, protected content and generated media. Verify the production license requirements are satisfied.

05 Maintain and troubleshoot Kirby

Because content lives in files, coordinate deployments so they do not overwrite editorial changes made on the server. Back up the content tree and custom templates before an update.

Keep files and data together in your recovery plan, test application updates in a copy when practical, and review logs after deployment. If installation fails, record the exact error, selected application/PHP versions and destination path before retrying.

A common question

Does a successful installation mean the whole application is ready for customers?

No. Verify the public content, permissions, forms or notifications and the features you actually use. An installer success message confirms provisioning, not your complete business workflow.

Was this answer helpful?

Need a little more help?

Our support team can help you find the next step.

Contact support