wawoxe/maintenance-bundle

Maintenance mode feature for Symfony application.

v1.0.1 2024-02-15 16:20 UTC

Requires

• php: >= 8.3
• symfony/http-kernel: >=7.0

Requires (Dev)

• phpunit/phpunit: ^11
• symfony/config: >=7.0
• symfony/dependency-injection: >=7.0
• symfony/yaml: >=7.0

MIT

• Mykyta Melnyk

README

MaintenanceBundle is a Symfony bundle that provides functionality for managing maintenance mode in Symfony applications. It allows you to easily enable maintenance mode and customize the maintenance response based on the request format.

Installation

You can install MaintenanceBundle via Composer. Run the following command:

composer require wawoxe/maintenance-bundle

Configuration

After installation, you need to configure MaintenanceBundle in your Symfony application. Here's an example configuration:

# Set up environment in Docker or Nginx/Apache.
MAINTENANCE_MODE=true
# Optional
MAINTENANCE_PRIORITY=1000
# Or run Symfony with MAINTENANCE_MODE
MAINTENANCE_MODE=true symfony serve

Optional: set your own class responsible for generating maintenance responses.

# config/services.yaml

services:
  maintenance.response:
    class: Wawoxe\MaintenanceBundle\Response\MaintenanceDefaultResponse

This configuration enables maintenance mode and specifies the priority of the maintenance event listener. You can customize the maintenance response by modifying the maintenance.response service definition.

Usage

Once configured, MaintenanceBundle will automatically handle maintenance mode for your Symfony application. When maintenance mode is enabled and a request is received, the maintenance listener will intercept the request and apply the maintenance response based on the request format.

You can customize the maintenance response by creating a custom class that implements the MaintenanceResponseInterface. Then, update the service definition for maintenance.response to use your custom class.

Testing

MaintenanceBundle includes PHPUnit tests to ensure the functionality is working as expected. You can run the tests using the following command:

composer test

Contributing

Contributions are welcome! If you have any suggestions, bug fixes, or feature requests, please open an issue or submit a pull request on GitHub.

License

MaintenanceBundle is open-source software licensed under the MIT license. See the LICENSE file for more information.