PHPackages                             nearata/flarum-ext-maintenance-mode - 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 &amp; Helpers](/categories/utility)
4. /
5. nearata/flarum-ext-maintenance-mode

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

nearata/flarum-ext-maintenance-mode
===================================

Customizable maintenance mode

1.0.0(3y ago)12.8kUnlicensePHP

Since Apr 29Pushed 3y ago1 watchersCompare

[ Source](https://github.com/Nearata/flarum-ext-maintenance-mode)[ Packagist](https://packagist.org/packages/nearata/flarum-ext-maintenance-mode)[ RSS](/packages/nearata-flarum-ext-maintenance-mode/feed)WikiDiscussions main Synced 1mo ago

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

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

[](#maintenance-mode)

> Customizable maintenance mode

Install
-------

[](#install)

```
composer require nearata/flarum-ext-maintenance-mode:"*"
```

Update
------

[](#update)

```
composer update nearata/flarum-ext-maintenance-mode:"*"
php flarum cache:clear
```

Remove
------

[](#remove)

```
composer remove nearata/flarum-ext-maintenance-mode
php flarum cache:clear
```

How to use
----------

[](#how-to-use)

Switch the `Maintenance Mode` in the extension settings page.

### With a command

[](#with-a-command)

```
php flarum nearataMaintenanceMode:toggle
```

### With API endpoint

[](#with-api-endpoint)

```
PATCH /api/nearata/maintenanceMode/enabled
```

```
{
  "value": true or false
}
```

if the body is empty, it will be evaluated as false.

An empty response is returned either way.

How to style
------------

[](#how-to-style)

To change the style of the page, there's no other way but to override the file itself.

Follow the below link to see a how-to:

How to bypass maintenance
-------------------------

[](#how-to-bypass-maintenance)

If you have permissions to bypass the maintenance mode, you can run the below command to generate a link to login in a authorized user.

Assure you are in the `Flarum root folder`:

```
php flarum nearataMaintenanceMode:auth
```

Note
----

[](#note)

- If the database is inaccessible, this situation is not handled.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity44

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

1109d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/061bc699f4894e9fe551110956a27d3d7f86efa23c955ff6d2ac119443008995?d=identicon)[Nearata](/maintainers/Nearata)

---

Top Contributors

[![Nearata](https://avatars.githubusercontent.com/u/26413668?v=4)](https://github.com/Nearata "Nearata (22 commits)")

---

Tags

flarumflarum-extensionflarum

### Embed Badge

![Health badge](/badges/nearata-flarum-ext-maintenance-mode/health.svg)

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

###  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)
