digifactory/laravel-partial-down

使用以下命令将应用程序的特定部分设置为维护模式:

v2.0.1 2022-09-14 13:24 UTC

This package is auto-updated.

Last update: 2024-09-14 18:20:49 UTC


README

Latest Version on Packagist MIT Licensed GitHub Workflow Status Quality Score StyleCI Total Downloads

此软件包提供了一个命令,可以将应用程序路由的特定部分设置为维护模式。这仅影响您的HTTP路由,因此队列和计划任务将继续运行。

安装

您可以通过Composer安装此软件包

composer require digifactory/laravel-partial-down

用法

您可以在用于路由或组的中间件中定义您希望设置为维护模式的组件

Route::group(['prefix' => 'backend', 'middleware' => 'partialDown:backend'], function () { });

Route::get('backend', function () { })->middleware('partialDown:backend');

现在您可以使用 artisan 命令将此部分应用程序设置为维护模式

php artisan partial-down backend

使用 partial-up 将其恢复在线

php artisan partial-up backend

partial-down 命令具有 Laravel 的 down 命令签名

protected $signature = 'partial-down {part}
                                     {--message= : The message for the maintenance mode}
                                     {--retry= : The number of seconds after which the request may be retried}
                                     {--allow=* : IP or networks allowed to access the application while in maintenance mode}';

当特定部分关闭且IP不允许时,将抛出 MaintenanceModeException,默认情况下 Laravel 使用 503 响应处理此异常。您可以进行自定义,有关更多信息,请参阅Laravel 文档

列出使用的组件

在大型应用程序中,查找所有使用的应用程序组件可能会很麻烦。您可以使用 php artisan partial-parts 命令查看所有使用的组件

php artisan partial-parts
+--------------+  
| Parts in use |  
+--------------+  
| backend      |  
| frontend     |  
+--------------+

测试

composer test

变更日志

有关最近更改的更多信息,请参阅变更日志

贡献

有关详细信息,请参阅贡献指南

安全

如果您发现任何与安全相关的问题,请通过电子邮件helpdesk@digifactory.nl联系,而不是使用问题跟踪器。

致谢

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅许可证文件

Laravel 软件包模板

此软件包是使用Laravel 软件包模板生成的。