Plack::Middleware::ErrorDocument(3pm)

Plack::Middleware::ErrorDocument3pm

Set error document based on http status code

Usage

  # in app.psgi
  use Plack::Builder;
  builder {
      enable "Plack::Middleware::ErrorDocument",
          500 => '/uri/errors/500.html', 404 => '/uri/errors/404.html',
          subrequest => 1;
      $app;
  };

Overview

Plack::Middleware::ErrorDocument allows you to customize error screen by setting paths (file system path or URI path) of error pages per status code.

Configurations

subrequest

A boolean flag to serve error pages using a new GET sub request. Defaults to false, which means it serves error pages using file system path.

  builder {
      enable "Plack::Middleware::ErrorDocument",
          502 => '/home/www/htdocs/errors/maint.html';
      enable "Plack::Middleware::ErrorDocument",
          404 => '/static/404.html', 403 => '/static/403.html', subrequest => 1;
      $app;
  };

This configuration serves 502 error pages from file system directly assuming that's when you probably maintain database etc. but serves 404 and 403 pages using a sub request so your application can do some logic there like logging or doing suggestions.

When using a subrequest, the subrequest should return a regular '200' response.

Releases

8 releases since Debian 6.0 (Squeeze); the text changed 7 times.

  1. 6.0
  2. 7
  3. 8
  4. 9
  5. 10
  6. 11
  7. 12
  8. 13

Author

Tatsuhiko Miyagawa

From libplack-perl 1.0051-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.