Posted on
• Apache Web Server

Setting up custom error pages (404, 403, 500)

Author
  • User
    Linux Bash
    Posts by this author
    Posts by this author

Setting Up Custom Error Pages in Linux using Bash

When managing a web server, encountering errors such as 404 (Not Found), 403 (Forbidden), or 500 (Internal Server Error) is quite common. However, the generic error pages that typically accompany these errors do little to enhance user experience or maintain your site’s aesthetic feel. By setting up custom error pages, you can provide a much better experience to your site visitors, while also potentially guiding them back to useful resources on your site.

In this blog post, we'll discuss how to set up custom error pages on an Apache server environment utilizing Bash commands. The focus will be on keeping things clear and manageable so that even new system administrators or hobbyists can effectively implement these customizations.

Requirements

  • A Linux server running Apache.
  • Basic knowledge of the Linux command line.
  • Permission to edit Apache configuration files and access to the terminal.

Step 1: Create Custom Error Pages

First, you need to create the HTML files that will be served when errors occur. Navigate to a directory where you want to keep these files, usually, it's best to keep them inside your website’s root directory.

cd /var/www/html
mkdir error_pages
cd error_pages
nano 404.html

In the nano editor, create a simple HTML file, or paste your custom HTML:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>404 Not Found</title>
</head>
<body>
    <h1>Oops! Page not found.</h1>
    <p>The page you are looking for might have been removed, had its name changed, or is temporarily unavailable.</p>
    <a href="/">Return home</a>
</body>
</html>

Save and exit nano (CTRL+X, Y then Enter). Repeat this process for other error pages such as 403.html and 500.html.

Step 2: Configure Apache to Use the Custom Error Pages

Once your error pages are ready, you need to configure Apache to use them. Open the Apache configuration file for your site, which might be located at /etc/apache2/sites-available/000-default.conf or another file if you have a virtual host setup.

sudo nano /etc/apache2/sites-available/000-default.conf

Add the following lines inside your <VirtualHost> block:

ErrorDocument 404 /error_pages/404.html
ErrorDocument 403 /error_pages/403.html
ErrorDocument 500 /error_pages/500.html

This tells Apache to use the specified HTML files as error documents for the corresponding error codes. Save and exit nano.

Step 3: Enable Changes and Restart Apache

For the changes to take effect, restart Apache:

sudo systemctl restart apache2

Testing Your Error Pages

To test whether your custom error pages are served correctly, you can try accessing paths on your server that do not exist or are forbidden. You can check this by simply typing:

curl -I http://yourdomain.com/nonexistent

This should return a 404 error using your custom 404 page.

Conclusion

Setting up custom error pages on your Linux Apache server can significantly improve your users’ experience during downtime or when encountering issues on your site. Not only does this make your website look more professional, but it also offers opportunities to redirect lost users back to working parts of your site. Proactive error page management can ease user frustration and help maintain your site’s reputation even when errors occur.

Whether an impassioned blogger or a seasoned webmaster, taking the time upfront to personalize your website's error handling can pave the way to a smoother, more engaging user experience. Remember, every detail counts when you want to keep your audience coming back.

Further Reading

For more insights and detailed guidance on similar topics, consider checking out the following resources:

Related posts