Symphony.

Overview

Maintenance Mode is a system state that allows an administrator to temporarily take a Symphony project “offline,” disabling access to the front end for non-authors and replacing it with a single placeholder page.

As its name suggests, maintenance mode can be very helpful when performing system maintenance or upgrades: logged-in authors are able to access the front end normally for debugging and testing purposes, while other visitors are served a fully configurable placeholder page.

Usage

Enabling/Disabling Maintenance Mode

Maintenance mode can be enabled and disabled in the admin interface, under System > Preferences. Ticking or unticking the “Enable Maintenance Mode” box and clicking “Save Changes” will toggle maintenance mode on and off.

Alternatively, maintenance mode can be enabled or disabled by directly editing the file at manifest/config.php and setting the value of maintenance_mode['enabled'] to no or yes:

            
    ###### MAINTENANCE_MODE ###### 
    'maintenance_mode' => array( 
        'enabled' => 'no', 
    ), 
    ########
          

Setting the placeholder page

By default, Symphony will display a generic system page to visitors who attempt to access a site with maintenance mode enabled. To display a custom placeholder page instead, simply create a page with a page type of “maintenance”.

Note that, while in maintenance mode, unauthenticated users will not be able to access any other pages. This means it’s usually a good idea when designing a maintenance page to disable any default navigation and to avoid linking to or using content provided by other pages. A maintenance page can, however, continue to utilize assets in the workspace directory (images, stylesheets, or JavaScript files, for instance).