如何在Ubuntu 14.04上配置Apache以使用自定义错误页面

2018-09-26 09:52:05 浏览数 (1)

介绍

Apache是世界上最受欢迎的Web服务器。它功能强大,功能丰富且灵活。在设计网页时,有助于自定义那些客户将看的所有内容,当然这些内容也包括他们请求不可用内容时的错误页面。在本指南中,我们将演示如何配置Apache从而在Ubuntu 14.04上使用自定义错误页面。

先决条件

要开始使用本指南,您需要具有sudo权限的非root用户。没有服务器的同学可以在这里购买,不过我个人更推荐您使用免费的腾讯云开发者实验室进行试验,学会安装后在购买服务器。您还需要在系统上安装Apache。

创建自定义错误页面

为了达到演示的目的,我们将创建一些自定义错误页面,但您的自定义页面显然会有所不同。

我们将自定义错误页面放在/var/www/html目录中,也就是Ubuntu的Apache安装为其设置的默认文档根。我们将为404错误调用一个名为custom_404.html的页面,同时也为500级错误调用一个名为custom_50x.html的页面。如果您只是测试,则可以使用以下行。否则,将您自己的内容放在以下位置:

代码语言:javascript复制
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

我们现在有两个自定义错误页面,这两个页面可以在客户端请求导致不同错误的时侯提供。

配置Apache以使用错误页面

现在,我们只需要告诉Apache,当出现正确的错误条件,就应该使用这些页面。在你想要配置的目录/etc/apache2/sites-enabled中打开虚拟主机文件。我们将使用默认的服务器块文件000-default.conf,但如果您使用的是非默认文件,则应调整自己的服务器块:

代码语言:javascript复制
sudo nano /etc/apache2/sites-enabled/000-default.conf

我们现在可以将Apache指向我们的自定义错误页面。

将错误导向正确的自定义页面

我们可以使用ErrorDocument指令将每种类型的错误与关联的错误页面相关联。这可以在当前定义的虚拟主机中设置。基本上,我们只需将每个错误的http状态代码映射到该错误发生时出现的页面即可。

再我们的示例中,错误映射将如下所示:

代码语言:javascript复制
<VirtualHost *:80>
    ServerAdmin webmaster@localhost
    DocumentRoot /var/www/html
​
    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined
​
    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
</VirtualHost>

此项更改就足以在指定错误发生时为其提供自定义错误页面。

然而,我们还将添加一组额外的配置,这样的话,客户端无法直接请求我们的错误页面。这可以防止当http状态为“200”(表示请求成功)时,仍然出现一些奇怪的现象比如页面文本引用错误。

用404响应直接请求错误页面

要实现此行为,我们需要为每个自定义页面添加一个Files块。在里面,我们可以测试是否设置了环境变量REDIRECT_STATUS。我们只应在ErrorDocument指令处理请求时设置此项。如果环境变量为空,我们将发出404错误:

代码语言:javascript复制
<VirtualHost *:80>
​
    . . .
​
    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>
</VirtualHost>

当客户端直接请求错误页面时,404错误将会发生,因为未设置正确的环境变量。

设置500级错误的测试

我们可以通过请求不存在的内容轻松生成404错误来测试我们的配置。要测试500级错误,我们必须设置一个虚拟代理传递,以便我们可以确保返回正确的页面。

ProxyPass指令添加到虚拟主机的底部。在本地计算机上为/proxytest发送请求到端口9000(该端口没有运行服务):

代码语言:javascript复制
<VirtualHost *:80>
​
    . . .
​
    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"
</VirtualHost>

完成后保存并关闭文件。

现在,键入以下命令启用mod_proxymod_proxy_http模块:

代码语言:javascript复制
sudo a2enmod proxy
sudo a2enmod proxy_http

重新启动Apache并测试您的页面

键入以下命令测试配置文件中的语法错误:

代码语言:javascript复制
sudo apache2ctl configtest

解决报告中出现的任何问题。当您的文件不包含语法错误时,请键入以下命令重启Apache:

代码语言:javascript复制
sudo service apache2 restart

现在,当您转到服务器的域或IP地址并请求不存在的文件时,您应该看到我们设置的404页面:

代码语言:javascript复制
http://server_domain_or_IP/thiswillerror

当您转到我们为虚拟代理通行证设置的位置时,将在我们的自定义500级页面上收到“503 service unavailable”错误:

代码语言:javascript复制
http://server_domain_or_IP/proxytest

您现在可以返回并从Apache配置中删除伪代理传递行。如果您不需要在其他地方使用代理模块,则可以禁用它们:

代码语言:javascript复制
sudo a2dismod proxy
sudo a2dismod proxy_http

再次重新启动服务器以实现这些更改:

代码语言:javascript复制
sudo service apache2 restart

结论

您现在应该为您的网站提供自定义错误页面。即使当年的客户遇到问题,这也是一种简化用户体验个性化的方法。给这些页面的一个建议是,在其中加入可以指引他们获取帮助或更多信息的位置链接。如果你打算采取这个建议,请确保即使在发生相关错误的情况下,该链接也是可以被访问的。

更多Ubuntu 教程请前往腾讯云 社区学习更多知识。


参考文献:《How To Configure Apache to Use Custom Error Pages on Ubuntu 14.04》

0 人点赞