Difference between revisions of "Maintenance mode"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 2.5. Up-to-date documentation for the latest stable version of Moodle may be available here: Maintenance mode.

(schedule maintenance mode)
m (CLI maintenance mode)
Line 18: Line 18:
 
==CLI maintenance mode==
 
==CLI maintenance mode==
  
Admins can enable CLI maintenance mode by adding file from the command line <code>$CFG->dataroot/climaintenance.html</code>. The difference from the standard maintenance mode is that all web access is prevented, CLI scripts continue to work. This CLI maintenance mode is used often during CLI version upgrades.
+
Admins can enable CLI maintenance mode by adding file from the command line <code>$CFG->dataroot/climaintenance.html</code>. The difference from the standard maintenance mode is that all web access is prevented, CLI scripts continue to work (with the exception of admin/cli/cron.php). This CLI maintenance mode is used often during CLI version upgrades.
 
{{New features}}
 
{{New features}}
 
It's possible using the admin/cli/maintenance.php mode to schedule the CLI maintenance mode and then to  display a message to users warning them when the site will become unavailable. See MDL-37596
 
It's possible using the admin/cli/maintenance.php mode to schedule the CLI maintenance mode and then to  display a message to users warning them when the site will become unavailable. See MDL-37596

Revision as of 15:10, 17 July 2013

Maintenance mode is for preventing any users other than administrators from using the site while maintenance is taking place, though it's not designed to prevent user access during version upgrades.

When users attempt to access a course when your site is in maintenance mode, they obtain a message informing them that the site is in maintenance mode. If you wish, you can create a customized maintenance mode message, perhaps stating when the site will be available again or giving the reason for doing maintenance.

Note: The front page of your site will appear as normal when your site is in maintenance mode. Users will only see the maintenance mode message when they attempt to access a course.

Setting maintenance mode

An administrator can put the site into maintenance mode in Settings > Site administration > Server > Maintenance mode.

If for some reason the web interface is not available you can also put the Moodle installation in maintenance mode by creating a file called maintenance.html in the folder called 1 (i.e. numeric 'one') in your moodle data folder. Any text in that file will be displayed to users trying to access anything other than the frontpage.

When you go into Maintenance mode and create this file you will need to test the Maintenance mode to make sure that you can come out of Maintenance mode and a non admin user can login. If they can't you may have to delete the maintenance.html for non admin users to be able to login. Be sure it works before you are stuck in Maintenance mode and non admin users are unable to login past the front page.

When a site is in maintenance mode, the link "In Maintenance Mode" is displayed near the top right of each page (except the front page) for admins.

CLI maintenance mode

Admins can enable CLI maintenance mode by adding file from the command line
$CFG->dataroot/climaintenance.html
. The difference from the standard maintenance mode is that all web access is prevented, CLI scripts continue to work (with the exception of admin/cli/cron.php). This CLI maintenance mode is used often during CLI version upgrades.

New feature
in Moodle 2.5!

It's possible using the admin/cli/maintenance.php mode to schedule the CLI maintenance mode and then to display a message to users warning them when the site will become unavailable. See MDL-37596

Scheduled maintenance mode

See also the section on maintenance mode in Administration via command line.

See also