congnqnexlesoft/symfony-maintenance-mode

A custom maintenance mode for Symfony

v1.0.5 2024-05-15 07:08 UTC

Requires

• php: ^7.2.3
• ext-json: *
• symfony/console: ^4.0
• symfony/framework-bundle: ^4.0

MIT

• Cong Nguyen Quang

• symfony
• maintenance
• mode

README

• The module is built upon the https://github.com/rdehnhardt/lumen-maintenance-mode package and customized for Symfony 4.4 and PHP 7.2

How to install

composer require congnqnexlesoft/symfony-maintenance-mode

How to configure

In config/services.yaml, add this instruction in services providers

    # [BEGIN] congnqnexlesoft/lumen-maintenance-mode
    CongnqNexlesoft\MaintenanceMode\ConsoleCommand\MaintenanceMode\DownCommand:
      class: CongnqNexlesoft\MaintenanceMode\ConsoleCommand\MaintenanceMode\DownCommand
      tags: [ 'console.command' ]
    CongnqNexlesoft\MaintenanceMode\ConsoleCommand\MaintenanceMode\UpCommand:
      class: CongnqNexlesoft\MaintenanceMode\ConsoleCommand\MaintenanceMode\UpCommand
      tags: [ 'console.command' ]
    CongnqNexlesoft\MaintenanceMode\MaintenanceModeService:
      autowire: true
    CongnqNexlesoft\MaintenanceMode\Http\Middleware\MaintenanceModeMiddleware:
      class: CongnqNexlesoft\MaintenanceMode\Http\Middleware\MaintenanceModeMiddleware
      arguments:
        - '@CongnqNexlesoft\MaintenanceMode\MaintenanceModeService'
      tags:
        - { name: kernel.event_listener, event: kernel.request, method: onRequest }
    # [END] congnqnexlesoft/lumen-maintenance-mode

Response

Using JSON

• Require config the line below to your .env file

## congnqnexlesoft/lumen-maintenance-mode ##
MAINTENANCE_RESPONSE_FORMAT=json

Copy these files to your project (if):

public/.gitignore

Put the application into maintenance mode (Symfony)

php bin/console down

Bring the application out of maintenance mode (Symfony)

php bin/console up

DevOps

Release a new version

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