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

Maintenance mode: Difference between revisions

From MoodleDocs
(see also link)
(→‎CLI maintenance mode: better explanation.)
 
(36 intermediate revisions by 17 users not shown)
Line 1: Line 1:
The idea of maintenance mode is to prevent any users other than admin to use the site while the maintenance process takes place.
{{Server settings}}
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 students/guests/teachers try access a course in maintenance mode, they will obtain a message saying the course is in maintenance mode. A customized message may be added, perhaps stating when the site will be available again or giving the reason for doing maintenance.
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 ''Administration > Site administration > Server > Maintenance mode''.
 
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.
 
If your session finished while still in Mainenance mode, you can re-login by typing the login URL directly (http://yoursitename/login/)
 
==CLI maintenance mode==
 
Admins can enable CLI maintenance mode by adding a file named <code>climaintenance.html</code> into the moodledata directory (<code>$CFG->dataroot</code>). If it exists, this file will be sent to the navigator instead of the standard Moodle home page.
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 often used during CLI version upgrades.
 
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
{|
|[[File:maintenancecli25.png|thumb|Scheduled  maintenance mode]]
|}
See also the section on maintenance mode in [[Administration via command line]].


==See also==
==See also==
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=46451 Maintenance mode?] forum discussion


[[Category:Administrator]]
Forum discussions:
*[https://moodle.org/mod/forum/discuss.php?d=245299 Maintenance mode cannot be switched off]
*[https://moodle.org/mod/forum/discuss.php?d=251954 Moodle for Windows stuck in Maintenance mode]
*[https://moodle.org/mod/forum/discuss.php?d=318890 Turned on Maintenance and can't get back in]
 
[[es:Modo de mantenimiento]]
[[fr:Mode de maintenance]]
[[ja:メンテナンスモード]]
[[de:Wartungsmodus]]

Latest revision as of 10:52, 30 October 2015

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 Administration > Site administration > Server > Maintenance mode.

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.

If your session finished while still in Mainenance mode, you can re-login by typing the login URL directly (http://yoursitename/login/)

CLI maintenance mode

Admins can enable CLI maintenance mode by adding a file named climaintenance.html into the moodledata directory ($CFG->dataroot). If it exists, this file will be sent to the navigator instead of the standard Moodle home page. 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 often used during CLI version upgrades.

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

Forum discussions: