PHPackages                             yasudacloud/lumaintenance - 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. [Framework](/categories/framework)
4. /
5. yasudacloud/lumaintenance

ActiveLibrary[Framework](/categories/framework)

yasudacloud/lumaintenance
=========================

This is a library that supports Lumen Framework maintenance functions.

1.0.2(4y ago)04MITPHPPHP ^7.3|^8.0

Since May 10Pushed 4y ago1 watchersCompare

[ Source](https://github.com/yasudacloud/lumaintenance)[ Packagist](https://packagist.org/packages/yasudacloud/lumaintenance)[ RSS](/packages/yasudacloud-lumaintenance/feed)WikiDiscussions main Synced 1mo ago

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

[![StyleCI](https://camo.githubusercontent.com/0ee60cbdc3cbb34cb1066484cca54fbb106a7a1e796b9a546da15b299336417f/68747470733a2f2f6769746875622e7374796c6563692e696f2f7265706f732f3335393333353430342f736869656c643f6272616e63683d6d61696e)](https://github.styleci.io/repos/359335404?branch=main)

Welcome to lumaintenance
------------------------

[](#welcome-to-lumaintenance)

This repository allows you to use the maintenance features in Lumen.

There are two ways to make maintenance changes: by generating a local file or by using environment variables.

Required for installation
-------------------------

[](#required-for-installation)

```
php: ^7.3|^8.0
laravel/lumen-framework: ^8.0

```

setup (Run within the Lumen project)
------------------------------------

[](#setup-run-within-the-lumen-project)

### 1. Installation

[](#1-installation)

```
composer require yasudacloud/lumaintenance

```

### 2. Add the following to bootstrap/app.php

[](#2-add-the-following-to-bootstrapappphp)

```
use Lumaintenance\Providers\LumaintenanceServiceProvider;

$app->register(LumaintenanceServiceProvider::class);

```

### 3. Copy the configuration file

[](#3-copy-the-configuration-file)

```
cp vendor/yasudacloud/lumaintenance/config/lumaintenance.php config/lumaintenance.php

```

Use
===

[](#use)

### Maintenance status

[](#maintenance-status)

```
php artisan lumain

```

### Use a local file to put it in a maintenance state.

[](#use-a-local-file-to-put-it-in-a-maintenance-state)

```
php artisan lumain:local down

```

### If you want to restrict by IP address

[](#if-you-want-to-restrict-by-ip-address)

```
php artisan lumain:local down --allow=127.0.0.1,192.168.0.100

```

### Restore the original state

[](#restore-the-original-state)

```
php artisan lumain:local up

```

Changing the maintenance status by environment variables
--------------------------------------------------------

[](#changing-the-maintenance-status-by-environment-variables)

```
LUMAIN_IS_DOWN=true

```

LUMAIN\_IS\_DOWN must be set to something other than blank.

```
LUMAIN_EXCLUDE_PATH=api/healthcheck

```

For LUMAIN\_EXCLUDE\_PATH, enter the path you want to exclude from maintenance, such as a health check.

You can leave it blank, but you can only set one.

```
LUMAIN_ALLOW_IPS=127.0.0.1,192.168.0.100

```

LUMAIN\_ALLOW\_IPS sets the whitelist of IP addresses as well as the local file.

Note, however, that the IP address set in LUMAIN\_ALLOW\_IPS will also be set for local file maintenance.

DEMO
----

[](#demo)

[![demo/demo.gif](demo/demo.gif)](demo/demo.gif)

Customize the maintenance page
------------------------------

[](#customize-the-maintenance-page)

```
mkdir -p resources/views/lumaintenance
cp vendor/yasudacloud/lumaintenance/resources/views/maintenance.blade.php resources/views/lumaintenance/maintenance.blade.php

```

Other
-----

[](#other)

The HTTP status code for the maintenance page is 503 status code by default. You can change the setting in lumaintenance.php.

Contact
-------

[](#contact)

If you find any problems, please contact us at

```
hello@yasuda.cloud

```

Thanks to DeepL for the translation!

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity60

Established project with proven stability

 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 ~4 days

Total

3

Last Release

1819d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/77d9da8e651ef1c9f335cc4bebba9c05001b8b6935d596e862dc845dab60bbc8?d=identicon)[yasudacloud](/maintainers/yasudacloud)

---

Top Contributors

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

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/yasudacloud-lumaintenance/health.svg)

```
[![Health](https://phpackages.com/badges/yasudacloud-lumaintenance/health.svg)](https://phpackages.com/packages/yasudacloud-lumaintenance)
```

PHPackages © 2026

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