How to add a site-wide downtime error message in IIS, with a custom 503 error code?

Question

My website will be down for maintenance for some time, and I want to make sure sure that (1) search engines see a HTTP 503 error code for every page, and (2) humans see a friendly message describing the downtime, in line with downtime SEO best practices.

How do I set up IIS 7.5 such that every request gets a custom 503 error message?

score 13 · Accepted Answer · answered Feb 27 '13 at 19:40

One way is to use the Url-Rewrite extension.

You can then use a rule like this to catch all requests:

<system.webServer>
    ...
    <rewrite>
        <rules>
            <rule name="SiteDown" stopProcessing="true">
                <match url=".*" />
                <action type="CustomResponse" statusCode="503" statusReason="Down for maintenance" statusDescription="will be back up soon" />
            </rule>
        </rules>
    </rewrite>
</system.webServer>

This takes care of the Search Engines, for the users you can add the following:

<system.webServer>
      ...
     <httpErrors existingResponse="Auto" errorMode="Custom" defaultResponseMode="File">
        <remove statusCode="503" subStatusCode="-1" />
        <error statusCode="503" path="503.html" />
     </httpErrors>
</system.webServer>

and then put a 503.html file in the root of your site which has a nice error message. Because you can not use styles or images in the page that are on the site itself, you need to link to another site or put all styles and images inline in the html page.

This works but it means whenever we down our website for maintenance or stop our app pool then we have to add these configurations in our web.config file & later need to remove these once app is up. This is what I understand...please correct me if I am wrong. — Ankush Jain, Jul 03 '18 at 12:26
@AnkushJain - correct, but you can script them so you don't have to manually change the configs. — Peter Hahndorf, Jul 03 '18 at 12:30

score 9 · Answer 2 · edited May 23 '17 at 11:33

9

If one's using a .NET application with IIS, one can also use an app_offline.htm file to shut down an application and prevent pages from being requested with an appropriate 503 error code.

edited May 23 '17 at 11:33

Community

1

answered Feb 28 '13 at 23:27

Anirvan

401
1
3
14

2

+1, but for ASP.NET 2.0 apps status code returned is 404 ! Solution is temporary set 4.0 app pool to the site – Antonio Bakula Mar 16 '13 at 13:33
this is the best answer, simple, catch all page, rules proper code! – Zyo Jul 07 '16 at 04:33

score 3 · Answer 3 · answered Feb 27 '13 at 19:33

You can setup a web.config in the following and put it in your root directory.

<rule name="Send 503" patternSyntax="Wildcard" stopProcessing="true">
  <match url="*" />
  <action type="CustomResponse" statusCode="503" subStatusCode="0" statusReason="Service Unavailable" statusDescription="The server is down for maintenance" />
</rule>

How to add a site-wide downtime error message in IIS, with a custom 503 error code?

3 Answers3

Linked