README

欢迎使用 lumaintenance

此仓库允许您在 Lumen 中使用维护功能。

有两种方式来进行维护更改：通过生成本地文件或使用环境变量。

安装要求

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

setup（在 Lumen 项目内运行）

1. 安装

composer require yasudacloud/lumaintenance

2. 将以下内容添加到 bootstrap/app.php 中

use Lumaintenance\Providers\LumaintenanceServiceProvider;


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

3. 复制配置文件

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

使用方法

维护状态

php artisan lumain

使用本地文件将其置于维护状态。

php artisan lumain:local down

如果您想按 IP 地址限制

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

恢复原始状态

php artisan lumain:local up

通过环境变量更改维护状态

LUMAIN_IS_DOWN=true

LUMAIN_IS_DOWN 必须设置为一个非空值。

LUMAIN_EXCLUDE_PATH=api/healthcheck

LUMAIN_EXCLUDE_PATH 应输入您想排除在维护之外的路径，例如健康检查。

您可以留空，但只能设置一个。

LUMAIN_ALLOW_IPS=127.0.0.1,192.168.0.100

LUMAIN_ALLOW_IPS 设置了与本地文件相同的 IP 白名单。

但是请注意，在 LUMAIN_ALLOW_IPS 中设置的 IP 地址也会用于本地文件维护。

DEMO

自定义维护页面

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

其他

默认情况下，维护页面的 HTTP 状态码为 503。您可以在 lumaintenance.php 中更改此设置。

联系方式

如果您发现任何问题，请通过以下方式联系我们

hello@yasuda.cloud

感谢 DeepL 的翻译！

yasudacloud / lumaintenance

维护者

详情