Giter VIP home page Giter VIP logo

ezplatform-maintenance-mode's Introduction

Ibexa DXP Maintenance Mode Bundle

This Ibexa DXP v3.x+ bundle provides a simple way to switch the whole site or selected SiteAccess to maintenance mode.

In this mode the site (or particular SiteAccess) will not be available for the end-users. Selected template is displayed instead.

Installation

  • Install the bundle:
composer require kmadejski/ezplatform-maintenance-mode
  • If you do not use Symfony Flex, you have to enable the bundle manually in your config/bundles.php file:
    ...
    EzSystems\EzPlatformMaintenanceModeBundle\EzSystemsEzPlatformMaintenanceModeBundle::class => ['all' => true]
  • Clear application cache:
php bin/console cache:clear --env=prod

Configuration

Bundles configuratiton is SiteAccess-aware, therefore all options are configurable in ezplatform.yml under default SiteAccess configuration key (if you want to switch the whole site into maintenance mode) or under selected SiteAccess:

ezplatform:
    system:
        default:
            maintenance_mode:
                enabled: true

By default 503 HTTP response code is returned and a default template @EzSystemsEzPlatformMaintenanceMode/maintenance.html.twig is rendered. No IP addresses are allowed to visit the page. To modify this behaviour you can add an additional configuration as following example presents:

ezplatformgs:
    system:
        default:
            maintenance_mode:
                enabled: true
                allowed_ips: ['::1', '10.0.0.1', '192.168.0.0/16']
                response_code: 404
                template: '@Acme/custom_maintenance.html.twig'

ezplatform-maintenance-mode's People

Contributors

kmadejski avatar oltc-fperrin avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

oltc-fperrin

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.