Customize 404 Error Page

Steps to Customize Error Page in SearchBlox

  1. Prepare Custom Error Page
    Create an HTML file named 404.html with your custom error content
    Place the file in both locations:
    <SEARCHBLOX_INSTALLATION_PATH>/webapps/ROOT/
    <SEARCHBLOX_INSTALLATION_PATH>/webapps/ROOT/

  2. Stop SearchBlox Server

    sudo systemctl stop searchblox
    
  3. Edit the following configuration files:
    <SEARCHBLOX_INSTALLATION_PATH>/etc/webdefault.xml
    <SEARCHBLOX_INSTALLATION_PATH>/webapps/ROOT/WEB-INF/web.xml

  4. Give the following custom entries to add for the custom 404 and 403 error codes. This tells the webserver to serve up the custom page 404.html instead of the standard output for 404 and 403 errors.

Sample code snippet from webdefault.xml

<error-page>
  <error-code>404</error-code>
  <location>/404.html</location>
</error-page>
<error-page>
  <error-code>403</error-code>
  <location>/404.html</location>
</error-page>

Sample code snippet from web.xml

<error-page>
        <exception-type>java.lang.Exception</exception-type>
        <location>/admin/errorpage.jsp</location>
    </error-page>
<error-page>
  <error-code>404</error-code>
  <location>/404.html</location>
</error-page>
<error-page>
  <error-code>403</error-code>
  <location>/404.html</location>
</error-page>
    <security-constraint>
        <web-resource-collection>
  1. Please start SearchBlox and test the custom 404 page by giving an incorrect URL as SearchBlox endpoint.
    Please note that there is only one custom HTML page that can be used as a 404 error page.
    sudo systemctl start searchblox
    

Verification Steps

  1. Trigger a 404 error by accessing a non-existent URL
  2. Verify your custom page appears instead of the default error page
  3. Repeat verification for 403 errors if configured

What’s Next

You can go through the related sections below