CODEWITHSUNDEEP
pythondjangodjango-debug-toolbar
AlexBrand
AlexBrand

Reputation: 12429

django-debug-toolbar not showing up

I looked at other questions and can't figure it out...

I did the following to install django-debug-toolbar:

  1. pip install django-debug-toolbar
  2. added to middleware classes:
MIDDLEWARE_CLASSES = (
    'django.middleware.common.CommonMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    # Uncomment the next line for simple clickjacking protection:
    # 'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'debug_toolbar.middleware.DebugToolbarMiddleware',
)

3 Added INTERNAL_IPS:

INTERNAL_IPS = ('174.121.34.187',)

4 Added debug_toolbar to installed apps

I am not getting any errors or anything, and the toolbar doesn't show up on any page, not even admin.

I even added the directory of the debug_toolbar templates to my TEMPLATE_DIRS

Upvotes: 180

Views: 98098

Answers (30)

Dominic Frei
Dominic Frei

Reputation: 422

Update for 2024 (or Django 5+):

If you are new to Django and went through the tutorial first and found the Django Debug Toolbar there and then went through the installation steps for it, you will actually end up doing everything correctly, with just one small detail:

The example polls app in the Django tutorial deliberately shows incomplete HTML (to not bloat the tutorial too much - it's on purpose and they put a note into the tutorial).

Now, the issue is though that this is exactly the reason you'll end up with a perfectly working tutorial app, the toolbar showing on the admin panel (because it's complete HTML) but not in your app itself.

If that happens to you, make sure your template htmls (in case of the tutorial that would be: index.html, detail.html and results.html) are complete HTML, which means, they need an opening and closing html tag as well as a body tag.

For example, here is how the index.html from the tutorial should look like to make sure the Django Debug Toolbar works:

{% load static %}

<html>

<header>
    <link rel="stylesheet" href="{% static 'all_in_one_converter_app/styles.css' %}">
</header>

<body>

{% if latest_question_list %}
<ul>
    {% for question in latest_question_list %}
    <li><a href="{% url 'polls:detail' question.id %}">{{ question.question_text }}</a></li>
    {% endfor %}
</ul>
{% else %}
<p>No polls are available.</p>
{% endif %}

</body>
</html>

Upvotes: 0

Mark Chackerian
Mark Chackerian

Reputation: 23582

Docker

If you're developing with a Django server in a Docker container with docker, the instructions for enabling the toolbar don't work. The reason is related to the fact that the actual address that you would need to add to INTERNAL_IPS is going to be something dynamic, like 172.24.0.1. Rather than trying to dynamically set the value of INTERNAL_IPS, the straightforward solution is to replace the function that enables the toolbar, in your settings.py, for example:

DEBUG_TOOLBAR_CONFIG = {
    'SHOW_TOOLBAR_CALLBACK': lambda _request: DEBUG
}

This should also work for other dynamic routing situations, like Vagrant or Heroku.

Update May 2024

This commit in django-debug-toolbar v4.4.0 may fix Docker problems, but it's not guaranteed to work.

Here are some more details for the curious. As of 2019, the code in django_debug_tool that determines whether to show the toolbar examines the value of REMOTE_ADDR like this:

if request.META.get('REMOTE_ADDR', None) not in INTERNAL_IPS:
       return False

so if you don't actually know the value of REMOTE_ADDR due to your dynamic docker routing, the toolbar will not work. You can use the docker network command to see the dynamic IP values, for example docker network inspect my_docker_network_name

Upvotes: 47

user1658543
user1658543

Reputation:

If you come here, reading chapter 8 of the documentation: It is – as of 2023.9.3 – a documentation gotcha. For sake of simplicity, the Django docs do not use full, valid HTML templates (see the note under Write views that actually do something). This irritates the debug toolbar.

If you visit a page for which no route is defined, or the backend, the resulting (error-)page will be a valid HTML document, and the toolbar will be visible.

Therefore, to solve the issue, create a BASE_DIR/templates/base.html which contains a valid HTML document, and let your templates under BASE_DIR/polls/templates/polls extend it. Then the debug toolbar will show up.

A noteworthy gotcha in this context, {% extends "base.html" %} may not find a base.html in the same directory. You may have to write {% extends "polls/base.html" %} instead. Check the error log shown in the browser to see in which directories Django searched.

Upvotes: 0

mkohler
mkohler

Reputation: 159

I hobbled together a few of these answers into one that worked for me. Versions:

Django 4.2.1

django-debug-toolbar 4.1.0

  1. Add this to settings.py :

    if DEBUG:
    import mimetypes
    mimetypes.add_type("application/javascript", ".js", True)

  2. Delete pycache .pyc files.

  3. Clear web cache (ctrl+shft+delete)

Upvotes: 0

cdev
cdev

Reputation: 5391

I was getting the below error, but I was able to see the related components to the debug_toolbar in view page source. Then inspect page shows the below error.

Failed to load module script: Expected a JavaScript module script but the server responded with a MIME type of "text/plain". Strict MIME type checking is enforced for module scripts per HTML spec.

enter image description here

Then I added this in the settings.py and the error disappeared and I was able to see the toolbar.

if DEBUG:
import mimetypes
mimetypes.add_type("application/javascript", ".js", True)

Upvotes: 1

SayedMaheen
SayedMaheen

Reputation: 83

  1. Like you said I have configured everything said in documentation, still debug_toolbar was not showing up. Then I tried it in Firefox, it worked fine.

  2. Then from chrome, I inspect the webpage and change classname class="djdt-hidden". You can try changing it or removing it.

  3. run manage.py collectstatic and repeat the above step

  4. Actually you can skip steps 2 and 3, by editing

    .djdt-hidden{ display: none;}

    from path

    debug_toolbar/static/debug_toolbar/css/toolbar.css

  5. Add this two lines somewhere in settings.py

    import mimetypes

    mimetypes.add_type("application/javascript", ".js", True)

  6. in urls.py

    import debug_toolbar

    urlpatterns += [ path('__debug__/', include(debug_toolbar.urls)),]

  7. Use reference django debug toolbar installation

  1. If it still doesn't working then, create launch.json and mention different port number for debugging

` {

"version": "0.2.0",
"configurations": [
    
    {
        "name": "Python: Django",
        "type": "python",
        "request": "launch",
        "program": "${workspaceFolder}\\manage.py",
        "args": [
            "runserver",
            "9000",
        ],
        "django": true
    }
]

} `

  1. Important step: check your webpage/template is in proper format inorder to show debug_toolbar. use html boilerplate template to edit your page or add missing elements/tags like

    <html></html> <body></body> <head><head>

etc to your django template or import a layout

Upvotes: 4

Chris Pratt
Chris Pratt

Reputation: 239430

What is DEBUG set to? It won't load unless it's True.

If it's still not working, try adding '127.0.0.1' to INTERNAL_IPS as well.

UPDATE

This is a last-ditch-effort move, you shouldn't have to do this, but it will clearly show if there's merely some configuration issue or whether there's some larger issue.

Add the following to settings.py:

def show_toolbar(request):
    return True
SHOW_TOOLBAR_CALLBACK = show_toolbar

That will effectively remove all checks by debug toolbar to determine if it should or should not load itself; it will always just load. Only leave that in for testing purposes, if you forget and launch with it, all your visitors will get to see your debug toolbar too.

For explicit configuration, also see the official install docs here.

EDIT(6/17/2015):

Apparently the syntax for the nuclear option has changed. It's now in its own dictionary:

def show_toolbar(request):
    return True
DEBUG_TOOLBAR_CONFIG = {
    "SHOW_TOOLBAR_CALLBACK" : show_toolbar,
}

Their tests use this dictionary.

Upvotes: 228

Dhia Shalabi
Dhia Shalabi

Reputation: 1540

I have the same problem and I have tried all the solutions above and non of them worked. Then I tried to find out what is the main issues of this problem in my project, and it was coming from the template file. Make sure that your template content is inside the <body></body>.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>

</body>
</html>

Upvotes: 0

Bob Baeck
Bob Baeck

Reputation: 91

Everything is done, but in Chrome no "django debug toolbar" is showed.

Chrome console: Failed to load module script: Expected a JavaScript module script but the server responded with a MIME type of "text/plain". Strict MIME type checking is enforced for module scripts per HTML spec. (toolbar.js;1)

In EDGE, exactly from the same server and url, is the toolbar showed.

Upvotes: 0

Subhash CS
Subhash CS

Reputation: 1

Run the following command:

python manage.py migrate

Now run the server again

Upvotes: -2

Hamed Damirchi
Hamed Damirchi

Reputation: 103

if you are using windows, it might be from your registery. set HKEY_CLASSES_ROOT.js\Content Type to text/javascript instead of text/plain.

Upvotes: 0

hn_tired
hn_tired

Reputation: 942

have same issue after adding

urls.py
mimetypes.add_type("application/javascript", ".js", True)
urlpatterns = [...

and

DEBUG_TOOLBAR_CONFIG = {
 'INTERCEPT_REDIRECTS': False,
 'SHOW_TOOLBAR_CALLBACK': lambda request: True,
 'SHOW_TEMPLATE_CONTEXT': True,
 'INSERT_BEFORE': '</head>'
}

javascripts files added but all tags have class djdt-hidden and hidden

<div id="djDebug" class="djdt-hidden" dir="ltr" data-default-show="true">

i was using GoogleChrome

in FireFox bug was fixed and django toolbar icon appear

Upvotes: 0

Vladyslav Oliinyk
Vladyslav Oliinyk

Reputation: 118

It works for me.

#urls.py
if settings.DEBUG:
    from django.conf.urls.static import static
    import debug_toolbar
    import mimetypes

    mimetypes.add_type("application/javascript", ".js", True)

    urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
    urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

    urlpatterns = [path('__debug__/', include(debug_toolbar.urls)), ] + urlpatterns

Upvotes: 1

Vivek Sarvaiya
Vivek Sarvaiya

Reputation: 1

After many trial and error, this worked for me in Django=3.1 After writing all internal_ip, middleware, appending in url, put this code in settings.py at below

def show_toolbar(request):
return True


DEBUG_TOOLBAR_CONFIG = {
"SHOW_TOOLBAR_CALLBACK": show_toolbar,
'INSERT_BEFORE': '</head>'
}

Many of them suggested SHOW_TOOLBAR_CALLBACK, but in my case it only worked after added 'INSERT_BEFORE'

Upvotes: 0

Esequiel Albornoz
Esequiel Albornoz

Reputation: 121

I know this question is a bit old, but today i installed django-toolbar with docker and came across with the same issue, this solved it for me

INTERNAL_IPS = ["127.0.0.1", "10.0.2.2"]

import socket
hostname, _, ips = socket.gethostbyname_ex(socket.gethostname())
INTERNAL_IPS += [".".join(ip.split(".")[:-1] + ["1"]) for ip in ips]

As i read in a comment, the issue is that docker uses a dynamic ip, to solve this we can get the ip from the code above

Upvotes: 6

ogurets
ogurets

Reputation: 628

What got me is an outdated browser!

Noticed that it loads some stylesheets from debug toolbar and guessed it might be a front-end issue.

Upvotes: 0

jozo
jozo

Reputation: 4772

In the code I was working on, multiple small requests were made during handling of main request (it's very specific use case). They were requests handled by the same Django's thread. Django debug toolbar (DjDT) doesn't expect this behaviour and includes DjDT's toolbars to the first response and then it removes its state for the thread. So when main request was sent back to the browser, DjDT was not included in the response.

Lessons learned: DjDT saves it's state per thread. It removes state for a thread after the first response.

Upvotes: 0

Stryker
Stryker

Reputation: 6130

django 1.8.5:

I had to add the following to the project url.py file to get the debug toolbar display. After that debug tool bar is displayed.

 from django.conf.urls import include
 from django.conf.urls import patterns
 from django.conf import settings


  if settings.DEBUG:
      import debug_toolbar
      urlpatterns += patterns('',
              url(r'^__debug__/', include(debug_toolbar.urls)),
              )

django 1.10: and higher:

from django.conf.urls import include, url
from django.conf.urls import patterns
from django.conf import settings


if settings.DEBUG:

  import debug_toolbar
  urlpatterns =[
         url(r'^__debug__/', include(debug_toolbar.urls)),
         ] + urlpatterns

Also don't forget to include the debug_toolbar to your middleware. The Debug Toolbar is mostly implemented in a middleware. Enable it in your settings module as follows: (django newer versions)

MIDDLEWARE = [
# ...
'debug_toolbar.middleware.DebugToolbarMiddleware',
#

Old-style middleware:(need to have _CLASSES keywork in the Middleware)

MIDDLEWARE_CLASSES = [
# ...
'debug_toolbar.middleware.DebugToolbarMiddleware',
# ...
]

Upvotes: 3

dnaranjo
dnaranjo

Reputation: 3784

In my case I just needed to remove the python compiled files (*.pyc)

Upvotes: 2

Anoyz
Anoyz

Reputation: 7701

I tried everything, from setting DEBUG = True, to settings INTERNAL_IPS to my client's IP address, and even configuring Django Debug Toolbar manually (note that recent versions make all configurations automatically, such as adding the middleware and URLs). Nothing worked in a remote development server (though it did work locally). The ONLY thing that worked was configuring the toolbar as follows:

DEBUG_TOOLBAR_CONFIG = {
    "SHOW_TOOLBAR_CALLBACK" : lambda request: True,
}

This replaces the default method that decides if the toolbar should be shown, and always returns true.

Upvotes: 32

wolendranh
wolendranh

Reputation: 4292

For anyone who is using Pycharm 5 - template debug is not working there in some versions. Fixed in 5.0.4, affected vesions - 5.0.1, 5.0.2 Check out issue

Spend A LOT time to find that out. Maybe will help someone

Upvotes: 0

Petko M
Petko M

Reputation: 734

I had this problem and had to install the debug toolbar from source.

Version 1.4 has a problem where it's hidden if you use PureCSS and apparently other CSS frameworks.

This is the commit which fixes that.

The docs explain how to install from source.

Upvotes: 0

Adriano Silva
Adriano Silva

Reputation: 2576

I had the same problem using Vagrant. I solved this problem by adding ::ffff:192.168.33.1 to the INTERNAL_IPS as below example. 

INTERNAL_IPS = (
    '::ffff:192.168.33.1',
)

Remembering that 192.168.33.10 is the IP in my private network in Vagrantfile.

Upvotes: 0

Bas Koopmans
Bas Koopmans

Reputation: 341

Add 10.0.2.2 to your INTERNAL_IPS on Windows, it is used with vagrant internally

INTERNAL_IPS = ( '10.0.2.2', )

This should work.

Upvotes: 12

RemcoGerlich
RemcoGerlich

Reputation: 31270

In my case, it was another problem that hasn't been mentioned here yet: I had GZipMiddleware in my list of middlewares.

As the automatic configuration of debug toolbar puts the debug toolbar's middleware at the top, it only gets the "see" the gzipped HTML, to which it can't add the toolbar.

I removed GZipMiddleware in my development settings. Setting up the debug toolbar's configuration manually and placing the middleware after GZip's should also work.

Upvotes: 2

metakermit
metakermit

Reputation: 22341

I tried the configuration from pydanny's cookiecutter-django and it worked for me:

# django-debug-toolbar
MIDDLEWARE_CLASSES = Common.MIDDLEWARE_CLASSES + ('debug_toolbar.middleware.DebugToolbarMiddleware',)
INSTALLED_APPS += ('debug_toolbar',)

INTERNAL_IPS = ('127.0.0.1',)

DEBUG_TOOLBAR_CONFIG = {
    'DISABLE_PANELS': [
        'debug_toolbar.panels.redirects.RedirectsPanel',
    ],
    'SHOW_TEMPLATE_CONTEXT': True,
}
# end django-debug-toolbar

I just modified it by adding 'debug_toolbar.apps.DebugToolbarConfig' instead of 'debug_toolbar' as mentioned in the official django-debug-toolbar docs, as I'm using Django 1.7.

Upvotes: 3

Bob
Bob

Reputation: 6173

An addition to previous answers:

if the toolbar doesn't show up, but it loads in the html (check your site html in a browser, scroll down)

the issue can be that debug toolbar static files are not found (you can also see this in your site's access logs then, e.g. 404 errors for /static/debug_toolbar/js/toolbar.js)

It can be fixed the following way then (examples for nginx and apache):

nginx config:

location ~* ^/static/debug_toolbar/.+.(ico|css|js)$ {
    root [path to your python site-packages here]/site-packages/debug_toolbar;
}

apache config:

Alias /static/debug_toolbar [path to your python site-packages here]/site-packages/debug_toolbar/static/debug_toolbar

Or:

manage.py collectstatic

more on collectstatic here: https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#collectstatic

Or manualy move debug_toolbar folder of debug_toolbar static files to your set static files folder

Upvotes: 3

timothyashaw
timothyashaw

Reputation: 1399

Debug toolbar wants the ip address in request.META['REMOTE_ADDR'] to be set in the INTERNAL_IPS setting. Throw in a print statement in one of your views like such:

print("IP Address for debug-toolbar: " + request.META['REMOTE_ADDR'])

And then load that page. Make sure that IP is in your INTERNAL_IPS setting in settings.py.

Normally I'd think you would be able to determine the address easily by looking at your computer's ip address, but in my case I'm running the server in a Virtual Box with port forwarding...and who knows what happened. Despite not seeing it anywhere in ifconfig on the VB or my own OS, the IP that showed up in the REMOTE_ADDR key was what did the trick of activating the toolbar.

Upvotes: 104

Andre Manzano
Andre Manzano

Reputation: 21

I got the same problem, I solved it by looking at the Apache's error log. I got the apache running on mac os x with mod_wsgi The debug_toolbar's tamplete folder wasn't being load

Log sample:

==> /private/var/log/apache2/dummy-host2.example.com-error_log <==
[Sun Apr 27 23:23:48 2014] [error] [client 127.0.0.1] File does not exist: /Library/WebServer/Documents/rblreport/rbl/static/debug_toolbar, referer: http://127.0.0.1/

==> /private/var/log/apache2/dummy-host2.example.com-access_log <==
127.0.0.1 - - [27/Apr/2014:23:23:48 -0300] "GET /static/debug_toolbar/css/toolbar.css HTTP/1.1" 404 234 "http://127.0.0.1/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.9; rv:28.0) Gecko/20100101 Firefox/28.0"

I just add this line to my VirtualHost file:

Alias /static/debug_toolbar /Library/Python/2.7/site-packages/debug_toolbar/static/debug_toolbar
  • Of course you must change your python path

Upvotes: 1

TimStaley
TimStaley

Reputation: 535

For me this was as simple as typing 127.0.0.1:8000 into the address bar, rather than localhost:8000 which apparently was not matching the INTERNAL_IPS.

Upvotes: 2

Related Questions