congnqnexlesoft/lumen-maintenance-mode

Define application maintenance mode.

v1.1.7 2024-05-23 09:10 UTC

Requires

• php: ^7.4
• laravel/lumen-framework: ^6.0

MIT

• Cong Nguyen Quang
• Renato Dehnhardt
• Vagner do Carmo

• maintenance
• mode
• lumen

README

Lumen maintenance mode

• Author: https://github.com/rdehnhardt/lumen-maintenance-mode
• congnqnexlesoft clone and update for Lumen 6.x and PHP 7.4

How to install

• PHP 7.4

export PATH=/usr/local/Cellar/php@7.4/$(ls /usr/local/Cellar/php@7.4 | head -1)/bin:$PATH
php -v | grep "PHP 7.4"

composer require congnqnexlesoft/lumen-maintenance-mode

How to configure

In bootstrap/app.php, add this instruction in providers

$app->register(CongnqNexlesoft\MaintenanceMode\Providers\MaintenanceModeServiceProvider::class);

Response

Features:

• Using JSON response
• Except URIs
• Require config the line below to your .env file

## [BEGIN] congnqnexlesoft/laravel-maintenance-mode, lumen-maintenance-mode, symfony-maintenance-mode ##
MAINTENANCE_RESPONSE_FORMAT=json
#    separate by ,(comma)
EXCEPT_URIS=URI_1,URI_2
## [END] congnqnexlesoft/laravel-maintenance-mode, lumen-maintenance-mode, symfony-maintenance-mode ##

Using View

• Copy these files to your project:

resources/views/errors/503.blade.php
storage/framework/.gitignore

Put the application into maintenance mode.

php artisan down

Bring the application out of maintenance mode.

php artisan up

IP released for access

In .env file

ALLOWED_IPS=999.99.9.999,999.99.9.999,999.99.9.999

DevOps

Release a new version

sh .ops/release-a-new-version.sh