Maintenance mode: Difference between revisions
No edit summary |
|||
| (13 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{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''. | |||
Maintenance mode is for preventing any users other than administrators from using the site while maintenance is taking place. | |||
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. | 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. | ||
| Line 10: | Line 8: | ||
==Setting maintenance mode== | ==Setting maintenance mode== | ||
An administrator can put the site into maintenance mode in ''Settings > 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. | |||
==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 (with the exception of admin/cli/cron.php). This CLI maintenance mode is used often during CLI version upgrades. | |||
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 | *Using Moodle [http://moodle.org/mod/forum/discuss.php?d=46451 Maintenance mode?] forum discussion | ||
[[ | [[es:Modo de mantenimiento]] | ||
[[eu:Mantenu-modua]] | [[eu:Mantenu-modua]] | ||
[[fr:Mode de maintenance]] | [[fr:Mode de maintenance]] | ||
Latest revision as of 18:30, 9 November 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.
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.
See also the section on maintenance mode in Administration via command line.
See also
- Using Moodle Maintenance mode? forum discussion
