Going Down warns site visitors that the web site will be going down for
maintenance at a specified time, so they can finish edits or checkout before
that time. It can either display a warning with the time or a countdown
timer.
The default configuration displays a fixed position red overlay message at the
bottom of the browser window with the text '[site_name] is going offline for
maintenance: [offline_time]'. If Javascript is enabled in the browser, it will
display a countdown timer in place of '[offline_time]', which avoids any
confusion with timezones.
The module works by checking on each page request and each CRON run. If the
warning is enabled and the going down time has not passed, the warning is
displayed; once the time has passed, the next page request or CRON run
(whichever comes first) will trigger the selected action.
The action can be configured to be either:
- Put the site into maintenance mode - Shows the notice until the time then
places the site into maintenance mode. - Continue showing warning message - The notice will switch to the "Maintenance
mode" message but you will need to manually place into maintenance mode. - Stop showing warning message - The notice will disappear and you will need to
manually place into maintenance mode. - Put site into Read Only Mode - If the
Read Only Mode module is
enabled then this option will be available and will put the site into Read Only
Mode.
Installation
-
Install this module using the official Backdrop CMS instructions at
https://docs.backdropcms.org/documentation/extend-with-modules. -
Visit the configuration page under Administration > Configuration >
Development > Maintenance mode (admin/config/development/maintenance) to
customize settings.
Usage
Module configuration is added to the Maintenance mode administration page
(admin/config/development/maintenance). Settings include:
- Activating or disabling the warning.
- Setting the off-line action. Off-line action includes a default option to set
the site offline automatically. - Setting the off-line date and time.
- Setting the time format to use in the warning.
- Setting the warning message.
- Advanced - settings to control the CSS display of the warning message
container.
If page caching is enabled for anonymous users, you may need to clear the page
cache for the warning to show to anonymous users.
Issues
Bugs and Feature Requests should be reported in the Issue Queue:
https://github.com/backdrop-contrib/going_down/issues.
Current Maintainers
- Martin Price - System Horizons Ltd
- Collaboration and co-maintainers welcome!
Credits
- Ported to Backdrop CMS by - Martin Price - System Horizons Ltd.
- Port sponsored by System Horizons Ltd.
- Originally written for Drupal by tinker
License
This project is GPL v2 software.
See the LICENSE.txt file in this directory for complete text.