diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installation.rst | 7 | ||||
| -rw-r--r-- | docs/panels.rst | 11 |
2 files changed, 12 insertions, 6 deletions
diff --git a/docs/installation.rst b/docs/installation.rst index 1e228cb..32483df 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -28,9 +28,10 @@ Installation Tying into middleware allows each panel to be instantiated on request and rendering to happen on response. - The order of ``MIDDLEWARE_CLASSES`` is important: the Debug Toolbar - middleware must come after any other middleware that encodes the - response's content (such as GZipMiddleware). + 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``. .. note:: diff --git a/docs/panels.rst b/docs/panels.rst index a4b809e..b5b7b2e 100644 --- a/docs/panels.rst +++ b/docs/panels.rst @@ -30,12 +30,17 @@ Path: ``debug_toolbar.panels.settings_vars.SettingsVarsDebugPanel`` A list of settings in settings.py. -Header -~~~~~~ +Headers +~~~~~~~ Path: ``debug_toolbar.panels.headers.HeaderDebugPanel`` -Common HTTP headers. +This panels shows the HTTP request and response headers, as well as a +selection of values from the WSGI environment. + +Note that headers set by middleware placed before the debug toolbar middleware +in ``MIDDLEWARE_CLASSES`` won't be visible in the panel. The WSGI server +itself may also add response headers such as ``Date`` and ``Server``. Request ~~~~~~~ |