PHPackages                             rik5/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. [Admin Panels](/categories/admin)
4. /
5. rik5/maintenance-mode

ActiveLibrary[Admin Panels](/categories/admin)

rik5/maintenance-mode
=====================

A Filament plugin to toggle maintenance mode from the admin panel.

v1.0.3(6mo ago)036MITPHPPHP ^8.1

Since Dec 9Pushed 6mo agoCompare

[ Source](https://github.com/rik5/maintenance-mode)[ Packagist](https://packagist.org/packages/rik5/maintenance-mode)[ Docs](https://github.com/rik5/maintenance-mode)[ RSS](/packages/rik5-maintenance-mode/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (9)Versions (5)Used By (0)

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

[](#maintenance-mode)

A Filament plugin to toggle maintenance mode from the admin panel.

This plugin is inspired by [Keysaw's Laravel Filament Maintenance](https://github.com/Keysaw/laravel-filament-maintenance).

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

[](#installation)

Install the package via Composer:

```
composer require rik5/maintenance-mode
```

Publish the config file:

```
php artisan vendor:publish --tag="maintenance-mode-config"
```

Setup
-----

[](#setup)

Add the plugin to your Panel configuration:

```
use Rik5\MaintenanceMode\MaintenanceModePlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            MaintenanceModePlugin::make(),
        ]);
}
```

Usage
-----

[](#usage)

The plugin adds a menu item to the user menu in the Filament admin panel. Clicking it toggles maintenance mode on or off using Laravel's `artisan down` and `up` commands.

When enabling maintenance mode, a secret token is generated (or uses the configured one) to bypass the maintenance page.

Configuration
-------------

[](#configuration)

- `secret`: Set a custom secret token or leave as null for auto-generated.
- `refresh`: Set refresh interval in seconds or false to disable.
- `permissions`: Restrict to users with specific permissions.
- `role`: Restrict to users with a specific role.
- `custom_view`: Use a custom maintenance page with animation (default: true).
- `block_api`: Block API endpoints during maintenance (default: false).

API Access During Maintenance
-----------------------------

[](#api-access-during-maintenance)

By default, API endpoints (`api/*`) are accessible even when maintenance mode is enabled. You can change this by setting `block_api` to `true` in the config file.

The package automatically replaces Laravel's default maintenance middleware to respect this configuration.

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance66

Regular maintenance activity

Popularity7

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity47

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

Every ~1 days

Total

4

Last Release

201d ago

### Community

Maintainers

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

---

Top Contributors

[![rik5](https://avatars.githubusercontent.com/u/38864886?v=4)](https://github.com/rik5 "rik5 (5 commits)")

---

Tags

laraveladminmaintenancefilament

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/rik5-maintenance-mode/health.svg)

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

###  Alternatives

[rawilk/profile-filament-plugin

Profile & MFA starter kit for filament.

3914.6k](/packages/rawilk-profile-filament-plugin)[stephenjude/filament-jetstream

A Laravel starter kit built with Filament inspired by Jetstream.

17760.2k3](/packages/stephenjude-filament-jetstream)[croustibat/filament-jobs-monitor

Background Jobs monitoring like Horizon for all drivers for FilamentPHP

274325.8k8](/packages/croustibat-filament-jobs-monitor)[stephenjude/filament-debugger

About

104162.2k2](/packages/stephenjude-filament-debugger)[mradder/filament-logger

Audit logging, activity tracking, exports, alerts, and dashboards for Filament admin panels.

2317.1k](/packages/mradder-filament-logger)[finity-labs/fin-mail

A powerful email template manager and composer for Filament with dynamic token replacement, template versioning, and inline email sending.

284.5k1](/packages/finity-labs-fin-mail)

PHPackages © 2026

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