Add docs for WSGIErrorOverride directive.

GrahamDumpleton · Sep 13, 2024 · ef3c4fd · ef3c4fd
1 parent d49ed1b
commit ef3c4fd
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/docs/configuration-directives/WSGIErrorOverride.rst b/docs/configuration-directives/WSGIErrorOverride.rst
@@ -0,0 +1,18 @@
+=================
+WSGIErrorOverride
+=================
+
+:Description: Enable/disable use of Apache error documents.
+:Syntax: ``WSGIErrorOverride On|Off``
+:Default: ``WSGIErrorOverride Off``
+:Context: server config, virtual host, directory, .htaccess
+
+The `WSGIErrorOverride`` directive when set to `On`, and the WSGI application is
+running in daemon mode, will result in Apache error documents being used rather
+than those passed back by the WSGI application. This allows error documents to
+match any web site that the WSGI application may be integrated as a part of.
+This feature is akin to the `ProxyErrorOverride`` directive of Apache but for
+mod_wsgi only.
+
+Note that this directive has no effect when the WSGI application is running in
+embedded mode.
diff --git a/docs/configuration-directives/WSGIMapHEADToGET.rst b/docs/configuration-directives/WSGIMapHEADToGET.rst
@@ -1,6 +1,6 @@
-==================
+================
 WSGIMapHEADToGET
-==================
+================
 
 :Description: Enable/disable mapping of HEAD request to GET.
 :Syntax: ``WSGIMapHEADToGET On|Off|Auto``

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -15,6 +15,7 @@ Configuration
    configuration-directives/WSGIChunkedRequest
    configuration-directives/WSGIDaemonProcess
    configuration-directives/WSGIDestroyInterpreter
+   configuration-directives/WSGIErrorOverride
    configuration-directives/WSGIImportScript
    configuration-directives/WSGILazyInitialization
    configuration-directives/WSGIMapHEADToGET