PHPackages                             moritzebeling/kirby-maintenance - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. moritzebeling/kirby-maintenance

ActiveKirby-plugin[Utility & Helpers](/categories/utility)

moritzebeling/kirby-maintenance
===============================

Kirby Maintenance mode plugin

1.0.0(3y ago)112462[2 PRs](https://github.com/moritzebeling/kirby-maintenance/pulls)MITPHP

Since Jan 22Pushed 2y ago2 watchersCompare

[ Source](https://github.com/moritzebeling/kirby-maintenance)[ Packagist](https://packagist.org/packages/moritzebeling/kirby-maintenance)[ Docs](https://github.com/moritzebeling/kirby-meintenance)[ RSS](/packages/moritzebeling-kirby-maintenance/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

Kirby Maintenance Mode Plugin
=============================

[](#kirby-maintenance-mode-plugin)

This plugin uses the `route:before` hook to hide the whole website from not-logged-in users when `option('maintenance')` is set to `true`. It also sends a `503` code.

Kirby urls like `assets`, `api`, `media`, `panel` will be ignored and are still available.

Installation
------------

[](#installation)

```
composer require moritzebeling/kirby-maintenance
composer update moritzebeling/kirby-maintenance
```

Or download/clone this repo into `site/plugins` of your Kirby project.

There are different ways to control the maintenance mode:

Via option
----------

[](#via-option)

```
// site/config.php
return [
    // one line switch
    'maintenance' => true,

    // more detailed configuration
    'moritzebeling.kirby-maintenance' => [
        'ignore' => [],
        'css' => false,
        'text' => 'This website is currently under maintenance and will be back online soon.',
    ]
];
```

Via panel
---------

[](#via-panel)

Add a field `maintenance` to the `site.yml` blueprint to meet the condition `$site->maintenance()->isTrue()`.

Via `$site->maintenance_text()` you could edit the text that would welcome any logged out website visitor.

You can also use one of the prefabricated blueprint parts:

- `tabs/maintenance`
- `sections/maintenance`
- `fields/maintenance`
- `fields/maintenance_text`

Via file
--------

[](#via-file)

You could also add a `/.maintenance` file to the Kirby root directory to switch on maintenance mode. This method is used by [bnomei/kirby3-janitor](https://github.com/bnomei/kirby3-janitor) plugin. If you enter any text inside that file, this will be the output when the site is in maintenance mode.

Suggested by [\#1](https://github.com/moritzebeling/kirby-maintenance/issues/1)

Add style
---------

[](#add-style)

With the `moritzebeling.kirby-maintenance.css` option you could add a stylesheet, e.g.:

```
/* /assets/css/maintenance.css */
body {
    width: 100%;
    height: 100%;
    margin: 0;
    padding: 1rem;
    display: flex;
    text-align: center;
    justify-content: center;
    align-items: center;
}
.message {
    max-width: 500px;
}
```

Development
-----------

[](#development)

1. Install a fresh Kirby StarterKit
2. `cd site/plugins`
3. `git clone` this repo

Roadmap

- Check if there is a page with the slug `maintenance`, if yes, display that page
- Allow pages to be ignored via field or blueprint option
- Multilang support

☕️ Support
----------

[](#️-support)

If you like this plugin, I would be glad if you would invite for on a coffee via [PayPal](http://more.moritzebeling.com/support)If you have any ideas for further development or stumble upon any problems, please open an issue or PR. Thank you!

Warranty
--------

[](#warranty)

This plugin is work in progress and comes without any warranty. Use at your own risk.

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1203d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/afeb4c41f68f31383f03af822e9dffebb802bf35b9b4e348d1715882e55c9e49?d=identicon)[moritzebeling](/maintainers/moritzebeling)

---

Top Contributors

[![moritzebeling](https://avatars.githubusercontent.com/u/39742729?v=4)](https://github.com/moritzebeling "moritzebeling (15 commits)")

---

Tags

kirbykirby-pluginmaintenancemaintenance-modestaging

### Embed Badge

![Health badge](/badges/moritzebeling-kirby-maintenance/health.svg)

```
[![Health](https://phpackages.com/badges/moritzebeling-kirby-maintenance/health.svg)](https://phpackages.com/packages/moritzebeling-kirby-maintenance)
```

###  Alternatives

[mzur/kirby-uniform

A versatile Kirby plugin to handle web form actions.

26068.3k13](/packages/mzur-kirby-uniform)[arnoson/kirby-vite

Vite helper for Kirby CMS

9759.2k3](/packages/arnoson-kirby-vite)[thathoff/kirby-git-content

Plugin to track changes to content in a git repository.

15343.7k](/packages/thathoff-kirby-git-content)[sylvainjule/locator

A map & geolocation field, built on top of open-source services / Mapbox

11237.3k1](/packages/sylvainjule-locator)[tobimori/kirby-seo

The default choice for SEO on Kirby: Implement technical SEO & Meta best practices with ease and provide an easy-to-use editor experience

10039.7k1](/packages/tobimori-kirby-seo)[fabianmichael/kirby-meta

Your all-in-one powerhouse for any SEO and metadata needs imaginable.

6910.7k1](/packages/fabianmichael-kirby-meta)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)