aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortschilling2014-07-15 16:43:22 -0400
committerAymeric Augustin2014-07-26 22:40:35 +0200
commit12746fa0f97db7d62183ea70f49bbe1f5af0be4d (patch)
treea44e0996fb7e5aeea7b75dc15b4c6ffe4b3a3103
parent92d4cbbc4aff93e67dde2a79cb85a3df2bdd13b9 (diff)
downloaddjango-debug-toolbar-12746fa0f97db7d62183ea70f49bbe1f5af0be4d.tar.bz2
Make note of the incompatability with the GZipMiddleware.
-rw-r--r--docs/installation.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index f761e91..4c79750 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -61,6 +61,11 @@ what it does, or if you prefer defining your settings explicitly, read below.
:exc:`~django.core.exceptions.ImproperlyConfigured` exception, follow the
explicit setup instructions.
+ When the automatic setup is used, the Debug Toolbar is not compatible with
+ :class:`~django.middleware.gzip.GZipMiddleware`. Please disable that
+ middleware during development or use the explicit setup to allow the
+ toolbar to function properly.
+
Explicit setup
--------------
@@ -105,7 +110,7 @@ settings module as follows::
The order of ``MIDDLEWARE_CLASSES`` is important. You should include the Debug
Toolbar middleware as early as possible in the list. However, it must come
after any other middleware that encodes the response's content, such as
-``GZipMiddleware``.
+:class:`~django.middleware.gzip.GZipMiddleware`.
If ``MIDDLEWARE_CLASSES`` doesn't contain the middleware, the Debug Toolbar
automatically adds it the beginning of the list.