Sylius Maintenance Plugin

Features

When your website is under maintenance, and you want to :

• Do not allow access to your website and display the message "the website is under maintenance" on the frontpage.
• Allow access to your website to some Ips addresses
• Activate and deactivate theses behaviors by commands
• Activate and deactivate behaviors in your Sylius Back-office
• Custom your message in your Sylius Back-office

Requirements

	Version
PHP	7.4, 8.0
Sylius	1.9, 1.10

Installation

1. Add the bundle and dependencies in your composer.json :

   composer require synolia/sylius-maintenance-plugin

2. Enable the plugin in your config/bundles.php file by add

   Synolia\SyliusMaintenancePlugin\SynoliaSyliusMaintenancePlugin::class => ['all' => true],

3. Import required config in your config/packages/_sylius.yaml file:

   imports:
       - { resource: "@SynoliaSyliusMaintenancePlugin/Resources/config/config.yaml" }

4. Import routing in your config/routes.yaml file:

   synolia_synolia_maintenance:
       resource: "@SynoliaSyliusMaintenancePlugin/Resources/config/admin_routing.yaml"
       prefix: '/%sylius_admin.path_name%'

5. Clear cache

   php bin/console cache:clear

Usage

• To turn your website under maintenance, please create a file maintenance.yaml at the root of your project.

• If you want to allow access for some Ips, please add these Ip into maintenance.yaml
  For example :

  ips: [172.16.254.1, 255.255.255.255, 192.0.0.255]

You can turn your website under maintenance by console commands :

1. Enable the plugin

    php bin/console maintenance:enable

2. Enable the plugin and add one or multiple ips addresses separated with a space

   php bin/console maintenance:enable 172.16.254.1 255.255.255.255 192.0.0.255

3. Disable the plugin

   php bin/console maintenance:disable

You can also turn your website under maintenance in Back Office :

• Enable/disable the plugin
• Allow access for one or multiple ips addresses (optional)
• Create your custom message (optional)

Development

See How to contribute.

License

This library is under the EUPL-1.2 license.

Credits

Developed by Synolia.