PHPackages                             klxf/flarum-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. klxf/flarum-maintenance

ActiveFlarum-extension[Utility & Helpers](/categories/utility)

klxf/flarum-maintenance
=======================

Highly customizable maintenance mode

1.1.0(8mo ago)1634MITPHP

Since Sep 15Pushed 8mo agoCompare

[ Source](https://github.com/klxf/flarum-maintenance)[ Packagist](https://packagist.org/packages/klxf/flarum-maintenance)[ RSS](/packages/klxf-flarum-maintenance/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (1)Versions (4)Used By (0)

Maintenance Mode
================

[](#maintenance-mode)

[![License](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667) [![Latest Stable Version](https://camo.githubusercontent.com/18fa9ea51bf8f32b87539128021c05fa1a27428a54442f0e3e0ebd3d0ebdf558/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6b6c78662f666c6172756d2d6d61696e74656e616e63652e737667)](https://packagist.org/packages/klxf/flarum-maintenance) [![Total Downloads](https://camo.githubusercontent.com/0784b1305cc7814a42917b8027c1d1e834bfeb151d79bafc51664f99a878f0f0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6b6c78662f666c6172756d2d6d61696e74656e616e63652e737667)](https://packagist.org/packages/klxf/flarum-maintenance)

A [Flarum](https://flarum.org) extension. Highly customizable maintenance mode.

Features
--------

[](#features)

- Enable/disable maintenance mode.
- Customizable maintenance page with HTML support.
- Only administrators can access the forum when maintenance mode is enabled.
- PHP commands to enable/disable maintenance mode.

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

[](#installation)

Install with composer:

```
composer require klxf/flarum-maintenance:"*"
```

Updating
--------

[](#updating)

```
composer update klxf/flarum-maintenance:"*"
php flarum migrate
php flarum cache:clear
```

Placeholders
------------

[](#placeholders)

You can use the following placeholders in the maintenance page:

- `$forumStyle` - The forum's CSS styles.
- `$settings` - The forum's settings.
    - Example: `$settings->get('forum_title')` for the forum title.
- `$url` - Flarum URL Generator.
    - Example: `$url->to('forum')->base()` for the forum base URL.

Use Developer Tokens Bypass Maintenance Mode
--------------------------------------------

[](#use-developer-tokens-bypass-maintenance-mode)

If you enable maintenance mode, you can still access the forum using developer tokens.

Enabling the "Enable Token Authentication" setting allows you to access the forum using developer tokens even when maintenance mode is enabled.

You can authenticate and login to the forum using the following URL:

```
{$forum_base_url}/maintenance/auth/{$token}

```

Commands
--------

[](#commands)

### Toggle Maintenance Mode

[](#toggle-maintenance-mode)

You can toggle maintenance mode using the following command:

```
php flarum maintenanceMode:toggle
```

Links
-----

[](#links)

- [Packagist](https://packagist.org/packages/klxf/flarum-maintenance)
- [GitHub](https://github.com/klxf/flarum-maintenance)

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance61

Regular maintenance activity

Popularity17

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity37

Early-stage or recently created project

 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

Every ~0 days

Total

3

Last Release

245d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/31070597?v=4)[Zhijian Fang](/maintainers/klxf)[@klxf](https://github.com/klxf)

---

Top Contributors

[![klxf](https://avatars.githubusercontent.com/u/31070597?v=4)](https://github.com/klxf "klxf (6 commits)")

---

Tags

flarum

### Embed Badge

![Health badge](/badges/klxf-flarum-maintenance/health.svg)

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

###  Alternatives

[fof/byobu

Well integrated, advanced private discussions.

61105.8k9](/packages/fof-byobu)[fof/user-bio

Add a user bio to user profiles

2196.5k9](/packages/fof-user-bio)[fof/links

Manage Flarum primary navbar menu links

39118.3k2](/packages/fof-links)[fof/drafts

Allow users to create post and discussion drafts

1771.1k5](/packages/fof-drafts)[fof/nightmode

Add a Night Mode option for your users to use on your Flarum forum

3774.5k2](/packages/fof-nightmode)[fof/best-answer

Mark a post as the best answer in a discussion

26135.2k15](/packages/fof-best-answer)

PHPackages © 2026

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