Skip to content

Commit 12746fa

Browse files
tim-schillingaaugustin
authored andcommitted
Make note of the incompatability with the GZipMiddleware.
1 parent 92d4cbb commit 12746fa

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/installation.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@ what it does, or if you prefer defining your settings explicitly, read below.
6161
:exc:`~django.core.exceptions.ImproperlyConfigured` exception, follow the
6262
explicit setup instructions.
6363

64+
When the automatic setup is used, the Debug Toolbar is not compatible with
65+
:class:`~django.middleware.gzip.GZipMiddleware`. Please disable that
66+
middleware during development or use the explicit setup to allow the
67+
toolbar to function properly.
68+
6469
Explicit setup
6570
--------------
6671

@@ -105,7 +110,7 @@ settings module as follows::
105110
The order of ``MIDDLEWARE_CLASSES`` is important. You should include the Debug
106111
Toolbar middleware as early as possible in the list. However, it must come
107112
after any other middleware that encodes the response's content, such as
108-
``GZipMiddleware``.
113+
:class:`~django.middleware.gzip.GZipMiddleware`.
109114

110115
If ``MIDDLEWARE_CLASSES`` doesn't contain the middleware, the Debug Toolbar
111116
automatically adds it the beginning of the list.

0 commit comments

Comments
 (0)