jontsa/maintenance-bundle

Symfony bundle to put your site in to maintenance mode.

1.0.0 2024-01-02 11:47 UTC

Requires

• php: ^8.0
• symfony/config: ^6.0|^7.0
• symfony/console: ^6.0|^7.0
• symfony/dependency-injection: ^6.0|^7.0
• symfony/http-kernel: ^6.0|^7.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-symfony: ^1.3
• phpunit/phpunit: ^9.5

MIT

README

A small bundle for Symfony 4/5 which provides commands to put your application in maintenance break during which all requests receive HTTP 503 response. This is done by throwing ServiceUnavailableHttpException and clients will receive either default Symfony error page or JSON message with correct HTTP status code.

Features

• Put your site to maintenance mode with single command
• Responds with HTTP 503 to requests during maintenance
• Optional IP-address whitelist. For example to allow access for load balancer health checks during maintenance.
• Lightweight bundle
• Recipes for Deployer

Requirements

• Symfony 5+
• PHP 7.4+
• composer

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Open a command console, enter your project directory and execute:

$ composer require jontsa/maintenance-bundle

Applications not using Symfony Flex

When not using Symfony Flex, you need to enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    Jontsa\Bundle\MaintenanceBundle\JontsaMaintenanceBundle::class => ['all' => true],
];

Usage

To put your site under maintenance mode

$ bin/console jontsa:maintenance enable

To disable maintenance mode

$ bin/console jontsa:maintenance disable

Configuration

To change default settings, create a configuration file.

# config/packages/jontsa_maintenance.yaml
jontsa_maintenance:
  whitelist:
    ip: [127.0.0.1, 192.168.0.0/24]
  lock_path: '%kernel.project_dir%/var/cache/maintenance'

• ip is an array of IP-addresses or networks which are allowed to access applications even during maintenance
• lock_path is the file path which is created during maintenance

Custom error page

If you want to customize the error page, check out Symfony documentation.