Apache でメンテナンス画面を出力する

Apache で運営しているサイトを更新する時に、404 NotFound や 500 Internal Server Error が発生しているとアクセスしてきたユーザーには不親切だと思います。なので、Apache でメンテナンス画面を表示する方法をメモしておきます。(まあこのブログではなんの意味もありませんが……)

※Apache2.2.22 で動作確認しています。

全体的な処理として今回行うのは、

  1. アクセスしてきたユーザーをメンテナンス画面(単純なhtmlファイル)にリダイレクトする
  2. 自分自身のアクセスの場合のみ、通常のサイトを表示する(動作確認用)

以上のことを .htaccess により設定します。


自分のIPを調べる

まずは、メンテナンス画面が正常に動作するかどうかの確認用のIPアドレスをメモしておきます。以下のようなサイトで表示される IPアドレスをメモします。
http://www.cman.jp/network/support/go_access.cgi
このIPアドレスは自分自身のことを指していて、この IP アドレスのみに通常のサイトを表示したり、逆にこのIPのみにメンテナンス画面を表示することで、実際に切り替える前に動作確認を行います。


メンテナンス画面を作成

ドキュメントルートに、maintenance.html などとしてメンテナンス中とわかるような表示を行うページを作成します。ここでは単純に以下のような html ファイルを作成します。
※実際にメンテナンス表示ページは、 Apache 側で用意されてはいるのですが、文章が英語なので日本向けのサイトを扱っている場合、日本語で用意していた方が親切かと思います。

maintenance.html

<h1>メンテナンス中です。</h1>


振り分け用の .htaccess の設定

メンテナンス用の振り分け設定の確認

アクセスしてきたユーザーを maintenance.html にリダイレクトする設定を行います。
しかし、いきなり実行してもし、設定がうまく行っていなかった場合、 500 Internal Server Error 等が表示されてしまうので(.htaccess の中身の誤字の場合はどうしても 500 エラーになります)、振り分けがきちんと動作するかを 上記で控えておいた IPアドレスのみにメンテナンス画面を表示します。以下をドキュメントルートの .htaccess に記述します。.htaccess ファイルが存在しない場合は作成します。
追記する場合は稼働中の .htaccess をコピーしてバックアップをとって置いた方がいいです。
(mod_rewrite と .htaccess は許可されているものと仮定しておきます。)

# これはファイルの先頭に
ErrorDocument 503 /maintenance.html

# 以下は既に  があればその直下に記述

  RewriteEngine On
  RewriteCond %{REQUEST_URI} !=/maintenance.html
  RewriteCond %{REMOTE_ADDR} =IPアドレス
  RewriteRule ^.*$ - [R=503,L]

ErrorDocument 503 /maintenance.html
503 のリダイレクト先を /maintenance.html というファイルに設定するという設定です

RewriteCond %{REQUEST_URI} !=/maintenance.html
リクエストされた URI が maintenance.html でない場合に、この記述以降に、最初に出てくる RewriteRule を実行する という設定になります。

RewriteCond %{REMOTE_ADDR} =IPアドレス
リクエストしてきた IPアドレスが 指定した IPアドレスの場合に、この記述以降に、最初に出てくる RewriteRule を実行する という設定になります。

RewriteRule ^.*$ – [R=503,L]
この記述の場合、リクエストしてきた URL が ^.*$ という正規表現にマッチする場合、次の [R=503,L] を処理します。
^.*$ は全てのどの文字列もマッチするので全てのリクエストという指定になります。
R=503 はリダイレクトを 503 リダイレクトとして処理することを意味します。一時的に移動していますという意味になります。
最後のカンマで区切られた L はこの条件が実行されればそれ以降の RewriteRule の処理は行われなくなります。

上記の “IPアドレス” の部分を初めに控えた IPアドレスに変更します。こうすることで、このIPアドレスの場合のみに maintenance.html にリダイレクトするようになります。

この状態で、初めにIPアドレスを確認したデバイスでサイトを閲覧すると、メンテナンス中です。と表示されるかと思います。そして、他のデバイスから(WiFiに繋がっていないスマートフォン等)確認すると、通常のサイトが表示されていれば成功です。

メンテンス対象を逆にする

現状では指定したIPアドレスからのアクセス時のみメンテンス画面を表示しているのですが、この設定を逆にして、指定したIPアドレス以外からのアクセスを全て、 maintenance.html にリダイレクトすることになります。
先ほどの .htaccess の以下の部分を

RewriteCond %{REMOTE_ADDR} =IPアドレス

次の用に変更します。

RewriteCond %{REMOTE_ADDR} !=IPアドレス

!= は次の条件では無いという意味で、 “IPアドレス” では無い場合に RewriteRule が適用される用になります。指定したIPアドレス以外の場合に、メンテンス画面にリダイレクトさせることになります。

以上で、メンテナンス画面を表示することができます。


設定を元に戻す

動作確認を終え、メンテナンスが終了した時に元に戻すには、.htaccess を新規作成した場合.htaccess を削除、.htaccess に追記した場合は、上記で設定した Rewrite…の設定をまるまる削除すると、通常通りサイトが表示されるようになります。バックアップをとっていた場合は、それを上書きか置き換えをすれば元通りです。


参考サイト

http://web-tan.forum.impressrd.jp/e/2009/06/16/5880