Each of the following steps needs to be configured for the Debug Toolbar to be fully functional.
Getting the code¶
The recommended way to install the Debug Toolbar is via pip:
$ python -m pip install django-debug-toolbar
If you aren’t familiar with pip, you may also obtain a copy of the
debug_toolbar directory and add it to your Python path.
To test an upcoming release, you can install the in-development version instead with the following command:
$ python -m pip install -e git+https://github.com/jazzband/django-debug-toolbar.git#egg=django-debug-toolbar
Make sure that
'django.contrib.staticfiles' is set up properly and add
'debug_toolbar' to your
INSTALLED_APPS = [ # ... 'django.contrib.staticfiles', # ... 'debug_toolbar', ] STATIC_URL = '/static/'
Make sure your
TEMPLATES setting contains a
APP_DIRS options is set to
True. It’s in there by default, so
you’ll only need to change this if you’ve changed that setting.
If you’re upgrading from a previous version, you should review the change log and look for specific upgrade instructions.
Setting up URLconf¶
Add the Debug Toolbar’s URLs to your project’s URLconf:
import debug_toolbar from django.conf import settings from django.urls import include, path urlpatterns = [ ... path('__debug__/', include(debug_toolbar.urls)), ]
This example uses the
__debug__ prefix, but you can use any prefix that
doesn’t clash with your application’s URLs. Note the lack of quotes around
The Debug Toolbar is mostly implemented in a middleware. Enable it in your settings module as follows:
MIDDLEWARE = [ # ... 'debug_toolbar.middleware.DebugToolbarMiddleware', # ... ]
The order of
MIDDLEWARE 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
Configuring Internal IPs¶
The Debug Toolbar is shown only if your IP address is listed in the
INTERNAL_IPS setting. This means that for local
development, you must add
you’ll need to create this setting if it doesn’t already exist in your
INTERNAL_IPS = [ # ... '127.0.0.1', # ... ]
You can change the logic of determining whether or not the Debug Toolbar should be shown with the SHOW_TOOLBAR_CALLBACK option. This option allows you to specify a custom function for this purpose.
On some platforms, the Django
runserver command may use incorrect content
types for static assets. To guess content types, Django relies on the
mimetypes module from the Python standard library, which itself relies
on the underlying platform’s map files. If you find improper content types for
certain files, it is most likely that the platform’s map files are incorrect or
need to be updated. This can be achieved, for example, by installing or
mailcap package on a Red Hat distribution,
a Debian distribution, or by editing the keys under
the Windows registry.
Cross-Origin Request Blocked¶
runserver is not impacted. However, if your application server and
static files server are at different origins, you may see CORS errors in
your browser’s development console:
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at http://localhost/static/debug_toolbar/js/toolbar.js. (Reason: CORS header ‘Access-Control-Allow-Origin’ missing).
Access to script at 'http://localhost/static/debug_toolbar/js/toolbar.js' from origin 'http://localhost:8000' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.
To resolve, configure your static files server to add the
Access-Control-Allow-Origin header with the origin of the application
server. For example, if your application server is at
and your static files are served by NGINX, add:
add_header Access-Control-Allow-Origin http://example.com;
And for Apache:
Header add Access-Control-Allow-Origin http://example.com
Django Channels & Async¶
The Debug Toolbar currently doesn’t support Django Channels or async projects. If you are using Django channels are having issues getting panels to load, please review the documentation for the configuration option RENDER_PANELS.