Maintenance Mode Package Installation Guide

For more information about this, see this post.



Install the package in the org you wish to try it in (can be a sandbox)
Ensure the package is installed for admins only

Screen Shot 2016-08-08 at 11.54.17

Once installed, go to the ‘Maintenance Config’ tab by clicking the ‘+’ button on the tab bar and click the ‘Perform Initial Setup’ button. You only need to click this once.

Screen Shot 2016-08-03 at 12.44.22

Screen Shot 2016-08-08 at 11.56.42

Once this has completed successfully, you will see the below;

Screen Shot 2016-08-08 at 13.31.00

Next, go to Setup > Develop > Sites

If you have a site already, you can skip this step next two steps

Screen Shot 2016-08-08 at 11.59.19

Enter a domain name you wish to use (remember, you cannot modify this once its been set) and press ‘Check Availability’ Once you have chosen a domain that is avaiable, accept the terms and conditions and press ‘Register My Domain’

Screen Shot 2016-08-08 at 12.01.33

Now, click ‘New’ and configure the site as follows;

Screen Shot 2016-08-08 at 12.02.28

Site Label: Maintenance Site

Active Site Home Page: SFDCMaintLoginSidebar

Default Web Address: maint

Clickjack Protection Level: allow framing by any page

Screen Shot 2016-08-08 at 12.23.57

Accept the defaults for the rest of the fields

If you have an existing site, under ‘Site Visualforce Pages’ click ‘Edit’

Screen Shot 2016-08-08 at 12.06.46

and then add the ‘SFDCMaintLoginSidebar’ page to the ‘Enabled Visualforce Pages’ section

Screen Shot 2016-08-08 at 12.06.59

Ensure you have activated your site when you are finished.

Once you have done this, Setup > Administer > Domain Management > My Domain

Under the ‘Authentication Configuration’ Heading, click ‘Edit’

Screen Shot 2016-08-08 at 12.18.06

Populate the ‘Right Frame URL’ with the URL of your site and press save.

Screen Shot 2016-08-08 at 12.14.25

Once you have completed these steps, logout of salesforce to check your changes have worked.

Make sure you login using your domain (not

Screen Shot 2016-08-08 at 12.25.12 (2)

Once logged in, go to Setup > Develop > Custom Metadata Types

Select ‘Manage Records’ next to ‘Salesforce Maintenance Exempt User’

Screen Shot 2016-08-08 at 13.36.51

Create a new record, and populate the details of the user you want to exclude from Maintenance freezes (e.g DevOps, System Admin)

Screen Shot 2016-08-08 at 13.37.22Once complete, go to the ‘Maintenance Configuration’ tab and press ‘Enable Maintenance Mode’

Screen Shot 2016-08-09 at 13.57.46

Any users who are not exempt will be frozen, and you will a different login page

Screen Shot 2016-08-09 at 13.58.26 (2)



One thought on “Maintenance Mode Package Installation Guide

Leave a Reply

Your email address will not be published. Required fields are marked *