CentOS7でカスタムエラーページを使用するようにApacheを設定する方法

提供:Dev Guides
移動先:案内検索

序章

Apacheは、世界で最も人気のあるWebサーバーです。 十分にサポートされ、機能が豊富で、柔軟性があります。 Webページをデザインするときは、ユーザーに表示されるすべてのコンテンツをカスタマイズすると役立つことがよくあります。 これには、利用できないコンテンツを要求した場合のエラーページが含まれます。 このガイドでは、CentOS7でカスタムエラーページを使用するようにApacheを設定する方法を示します。

前提条件

このガイドを開始するには、sudo権限を持つroot以外のユーザーが必要です。 このタイプのユーザーをセットアップするには、CentOS7初期セットアップガイドに従ってください。 また、システムにApacheをインストールする必要があります。 このガイドの最初の手順に従って、これを設定する方法を学びます。

カスタムエラーページの作成

デモンストレーション用にいくつかのカスタムエラーページを作成しますが、カスタムページは明らかに異なります。

カスタムエラーページは、CentOSのApacheインストールがデフォルトのドキュメントルートを設定する/var/www/htmlディレクトリに配置します。 custom_404.htmlと呼ばれる404エラーのページと、custom_50x.htmlと呼ばれる一般的な500レベルのエラーのページを作成します。 テストするだけの場合は、次の行を使用できます。 それ以外の場合は、次の場所に独自のコンテンツを配置します。

echo "<h1 style='color:red'>Error 404: Not found :-(</h1>" | sudo tee /var/www/html/custom_404.html
echo "<p>I have no idea where that file is, sorry.  Are you sure you typed in the correct URL?</p>" | sudo tee -a /var/www/html/custom_404.html
echo "<h1>Oops! Something went wrong...</h1>" | sudo tee /var/www/html/custom_50x.html
echo "<p>We seem to be having some technical difficulties. Hang tight.</p>" | sudo tee -a /var/www/html/custom_50x.html

これで、クライアントの要求によって異なるエラーが発生した場合に提供できる2つのカスタムエラーページができました。

エラーページを使用するようにApacheを設定する

ここで、正しいエラー状態が発生するたびにこれらのページを利用する必要があることをApacheに通知する必要があります。 Apacheが構成スニペットを読み取る/etc/httpd/conf.dディレクトリに新しい構成ファイルを作成できます。 新しいファイルをcustom_errors.confと呼びます。

sudo nano /etc/httpd/conf.d/custom_errors.conf

これで、Apacheにカスタムエラーページを指定できます。

正しいカスタムページへの直接エラー

ErrorDocumentディレクティブを使用して、各タイプのエラーを関連するエラーページに関連付けることができます。 基本的に、各エラーのhttpステータスコードを、エラーが発生したときに提供するページにマップする必要があります。

この例では、エラーマッピングは次のようになります。

/etc/httpd/conf.d/custom_errors.conf

ErrorDocument 404 /custom_404.html
ErrorDocument 500 /custom_50x.html
ErrorDocument 502 /custom_50x.html
ErrorDocument 503 /custom_50x.html
ErrorDocument 504 /custom_50x.html

この変更だけで、指定されたエラーが発生したときにカスタムエラーページを提供するのに十分です。

ただし、クライアントがエラーページを直接要求できないように、構成のセットを追加します。 これにより、ページのテキストがエラーを参照しているが、httpステータスが「200」(リクエストが成功したことを示す)であるという奇妙な状況を防ぐことができます。

エラーページが直接要求された場合は404で応答します

この動作を実装するには、カスタムページごとにFilesブロックを追加する必要があります。 内部では、REDIRECT_STATUS環境変数が設定されているかどうかをテストできます。 これは、ErrorDocumentディレクティブが要求を処理する場合にのみ設定する必要があります。 環境変数が空の場合、404エラーが発生します。

/etc/httpd/conf.d/custom_errors.conf

ErrorDocument 404 /custom_404.html
ErrorDocument 500 /custom_50x.html
ErrorDocument 502 /custom_50x.html
ErrorDocument 503 /custom_50x.html
ErrorDocument 504 /custom_50x.html

<Files "custom_404.html">
    <If "-z %{ENV:REDIRECT_STATUS}">
        RedirectMatch 404 ^/custom_404.html$
    </If>
</Files>

<Files "custom_50x.html">
    <If "-z %{ENV:REDIRECT_STATUS}">
        RedirectMatch 404 ^/custom_50x.html$
    </If>
</Files>

エラーページがクライアントから直接要求された場合、正しい環境変数が設定されていないため、404エラーが発生します。

500レベルのエラーのテストを設定する

存在しないコンテンツをリクエストすることで、構成をテストするための404エラーを簡単に生成できます。 500レベルのエラーをテストするには、ダミーのプロキシパスを設定して、正しいページが返されることを確認する必要があります。

ProxyPassディレクティブをファイルの最後に追加します。 /proxytestのリクエストをローカルマシン(サービスが実行されていない)のポート9000に送信します。

/etc/httpd/conf.d/custom_errors.conf

ErrorDocument 404 /custom_404.html
ErrorDocument 500 /custom_50x.html
ErrorDocument 502 /custom_50x.html
ErrorDocument 503 /custom_50x.html
ErrorDocument 504 /custom_50x.html

<Files "custom_404.html">
    <If "-z %{ENV:REDIRECT_STATUS}">
        RedirectMatch 404 ^/custom_404.html$
    </If>
</Files>

<Files "custom_50x.html">
    <If "-z %{ENV:REDIRECT_STATUS}">
        RedirectMatch 404 ^/custom_50x.html$
    </If>
</Files>

ProxyPass /proxytest "http://localhost:9000"

終了したら、ファイルを保存して閉じます。

Apacheを再起動してページをテストする

次のように入力して、構成ファイルの構文エラーをテストします。

sudo apachectl configtest

報告された問題に対処します。 ファイルに構文エラーが含まれていない場合は、次のように入力してApacheを再起動します。

sudo systemctl restart httpd

これで、サーバーのドメインまたはIPアドレスに移動して存在しないファイルを要求すると、次の404ページが表示されます。

http://server_domain_or_IP/thiswillerror

ダミープロキシパス用に設定した場所に移動すると、カスタム500レベルページで「503サービスを利用できません」というエラーが表示されます。

http://server_domain_or_IP/proxytest

これで、戻って、Apache構成から偽のプロキシパスラインを削除できます。

結論

これで、サイトのカスタムエラーページが表示されます。 これは、ユーザーが問題を抱えている場合でも、ユーザーエクスペリエンスをパーソナライズする簡単な方法です。 これらのページの1つの提案は、ヘルプや詳細情報を入手するために行くことができる場所へのリンクを含めることです。 これを行う場合は、関連するエラーが発生している場合でも、リンク先にアクセスできることを確認してください。