Use Maintenance Mode

Maintenance Mode restricts system access to designated roles while updates, data reviews, or security responses are in progress. When enabled, users who are not permitted to log in see a custom message until Maintenance Mode is turned off.

Who: Global administrators

When to Use Maintenance Mode

Use Maintenance Mode when:

• Making updates to a site and preventing other users from logging in during the change.
• Responding to a data breach by locking out all users except global administrators while the issue is investigated.

↑ Back to top

Enable Maintenance Mode

To enable Maintenance Mode:

1. Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and then click the Security tab.
2. Locate the System Security section and toggle Enable Maintenance Mode on.
    
3. Click the Roles Allowed to Log In field and select the applicable roles.
    
4. Click the Maintenance Mode Message field to add a custom message that appears to users who are unable to log in while Maintenance Mode is enabled. 
   • A clear message, such as one noting that the site is temporarily undergoing maintenance, helps users understand when to try again.
      
5. Click Save.

↑ Back to top

Manually Log Out Online Users

To manually log out online users:

1. Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and then click the System tab.
2. Locate the System Information section and click People Online.
    
3. Check the checkbox next to the users to log out.
    
4. Click the Logout icon.

↑ Back to top

Disable Maintenance Mode

To turn Maintenance Mode off and allow users to log in as normal:

1. Click the System Administration gear in the upper navigation bar, select Global Settings from the drop-down menu, and then click the Security tab.
2. Locate the System Security section and toggle Enable Maintenance Mode off.

↑ Back to top