canhph2/laravel-maintenance-mode

A custom maintenance mode for Laravel (JSON response support).

Maintainers

Details

github.com/canhph2/laravel-maintenance-mode

Source

Issues

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v1.1.1 2024-05-23 08:29 UTC

Requires

MIT 73d50a3dd1cfe513e23af612c7834e117d801b22

  • Cong Nguyen Quang <congnqnexlesoft.woop@gmail.com>

maintenancelaravelmodeJSON-response-support

This package is auto-updated.

Last update: 2025-04-15 08:21:23 UTC

README

  • A custom maintenance mode for Laravel (JSON response support).

How to install

  • required PHP >= 7.2, Laravel >= 5.8
composer require canhph2/laravel-maintenance-mode

How to configure

In app/Http/Kernel.php, add this middleware in $middleware array

  • [Required] Put MaintenanceModeMiddleware::class below \Spatie\Cors\Cors::class (should be 2nd item)
  • [Required] Don't use Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode
// 2nd, should below `Cors` and don't use 'Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode'
\CongnqNexlesoft\MaintenanceMode\Http\Middleware\MaintenanceModeMiddleware::class,

Response

Features:

  • Using JSON response
  • Except URIs
  • Require config the line below to your .env file
## [BEGIN] canhph2/laravel-maintenance-mode, lumen-maintenance-mode, symfony-maintenance-mode ##
MAINTENANCE_RESPONSE_FORMAT=json
#    separate by ,(comma)
EXCEPT_URIS=URI_1,URI_2
## [END] canhph2/laravel-maintenance-mode, lumen-maintenance-mode, symfony-maintenance-mode ##

Using View

  • Copy these files to your project (if):
resources/views/errors/503.blade.php
storage/framework/.gitignore

Put the application into maintenance mode (default in Laravel).

php artisan down

Bring the application out of maintenance mode (default in Laravel).

php artisan up

DevOps

Release a new version

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