PHPackages                             carlcs/craft-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. carlcs/craft-maintenance

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

carlcs/craft-maintenance
========================

Maintenance plugin for Craft CMS

v1.2.3(8y ago)681361[3 issues](https://github.com/carlcs/craft-maintenance/issues)PHPPHP >=5.3.0

Since Feb 23Pushed 8y ago1 watchersCompare

[ Source](https://github.com/carlcs/craft-maintenance)[ Packagist](https://packagist.org/packages/carlcs/craft-maintenance)[ RSS](/packages/carlcs-craft-maintenance/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (9)Dependencies (1)Versions (10)Used By (0)

Maintenance plugin for Craft CMS
================================

[](#maintenance-plugin-for-craft-cms)

[![screenshot](https://github.com/carlcs/craft-maintenance/raw/master/resources/screenshot.png)](https://github.com/carlcs/craft-maintenance/blob/master/resources/screenshot.png)

The plugin provides tools to help you do maintenance on your Craft CMS website:

- Display a “Maintenance in progress” overlay in the Control Panel when the site is undergoing [scheduled maintenance](#maintenance-modes)
- [Announce upcoming maintenance](#maintenance-announcements) on the dashboard and with notification banners
- Leave your users [(maintenance related) messages](#maintenance-messages) on the dashboard widget
- Access maintenance related info from your templates using the provided [template variables](#template-variables)

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

[](#installation)

The plugin is available on Packagist and can be installed using Composer. You can also download the [latest release](https://github.com/carlcs/craft-maintenance/releases/latest) and copy the files into craft/plugins/maintenance/.

```
$ composer require carlcs/craft-maintenance

```

Maintenance Announcements
-------------------------

[](#maintenance-announcements)

Set up maintenance announcements or messages from the plugin’s settings page. You can use markdown to add links, or to format the message. To configure scheduled maintenance you have to set a start date in the announcement’s settings and enable [“Backend Maintenance”](#backend-maintenance) and/or [“Frontend Maintenance”](#frontend-maintenance).

Create a new “Maintenance Announcements” widget to display all notifications on the users’ Dashboards. Upcoming maintenance will also be announced with a banner notification.

Maintenance Modes
-----------------

[](#maintenance-modes)

When backend maintenance mode is active, users navigating the Control Panel will be shown a full screen “Maintenance in progress” overlay. It informs them about the undergoing maintenance, in order to prevent from useless data entry.

The frontend maintenance mode redirects all (frontend) requests to /503, your “service unavailable” page. You can exclude URLs from being redirected and whitelist visitor IP addresses in the plugin settings.

**Note:** the plugin doesn’t do “content freeze” in a way, that it actually prevents data from being saved or changed in the database. That being said, there are template variables and plugins API provided.

Settings
--------

[](#settings)

The plugin can be configured from a craft/config/maintenance.php config file or from Settings/Maintenance.

In Settings/Users you can assign user permissions to configure the “Maintenance in progress” overlay or to grant access for individual user groups while frontend maintenance is carried out.

Template Variables
------------------

[](#template-variables)

The plugin provides template variables to get the active announcement model, or to check whether the site is currently undergoing maintenance.

#### `isCpMaintenance`

[](#iscpmaintenance)

Returns whether the Control Panel is currently undergoing maintenance.

```
{{ isCpMaintenance ? 'Shop closed' : 'Shop' }}
```

#### `isSiteMaintenance`

[](#issitemaintenance)

Returns whether the site is currently undergoing maintenance.

```
{% set reason = isSiteMaintenance ? 'scheduled' : 'unscheduled' %}
```

#### `getAnnouncement( timeInAdvance )`

[](#getannouncement-timeinadvance-)

Returns the latest, either currently active or soon to be activated maintenance announcement.

```
{% set announcement = craft.maintenance.getAnnouncement('2 hours') %}

{% if announcement and announcement.blockSite %}
    {{ announcement.message }}
{% endif %}
```

Planned features
----------------

[](#planned-features)

- Quick set up maintenance via environment variable

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 96.7% 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

Every ~70 days

Recently: every ~140 days

Total

9

Last Release

3211d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/7516543?v=4)[carlcs](/maintainers/carlcs)[@carlcs](https://github.com/carlcs)

---

Top Contributors

[![carlcs](https://avatars.githubusercontent.com/u/7516543?v=4)](https://github.com/carlcs "carlcs (29 commits)")[![espensgr](https://avatars.githubusercontent.com/u/3862891?v=4)](https://github.com/espensgr "espensgr (1 commits)")

---

Tags

craft-plugincraftcms

### Embed Badge

![Health badge](/badges/carlcs-craft-maintenance/health.svg)

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

###  Alternatives

[helsingborg-stad/municipio

A bootstrap theme for creating municipality sites.

4028.3k10](/packages/helsingborg-stad-municipio)[mautic/core

Mautic Open Source Distribution

9.8k2.6k9](/packages/mautic-core)[roots/wp-stage-switcher

WordPress plugin that allows you to switch between different environments from the admin bar

374458.3k3](/packages/roots-wp-stage-switcher)[vinkla/wordplate

The WordPlate boilerplate

2.2k5.3k](/packages/vinkla-wordplate)[mediawiki/maps

Adds various mapping features to MediaWiki

78149.7k3](/packages/mediawiki-maps)[rainlab/blog-plugin

Blog plugin for October CMS

17158.6k](/packages/rainlab-blog-plugin)

PHPackages © 2026

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