Document how to toggle django-debug-toolbar with envvar

[hmpf]

No description provided.

[elfjes]

nice, perhaps we can even throw in an assert "debug_toolbar" not in INSTALLED_APPS in a production settings.py file

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.75%. Comparing base (5a6b8c1) to head (8248265).
Report is 64 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #977      +/-   ##
==========================================
- Coverage   81.93%   80.75%   -1.19%     
==========================================
  Files         132      123       -9     
  Lines        4861     4188     -673     
==========================================
- Hits         3983     3382     -601     
+ Misses        878      806      -72     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[lunkwill42]

This did not work out of the box, though.

I've never used Django Debug Toolbar at all before, and it seems it's not enough to add some environment variable to make it work in Argus.

I had to put at least these things into my settings file as well, to make Django Debug Toolbar appear:

DEBUG=True

INTERNAL_IPS = [
    "127.0.0.1",
]

DEBUG_TOOLBAR_CONFIG = {
    "ROOT_TAG_EXTRA_ATTRS": "hx-preserve"
}

If you have to manipulate your settings file to make it work anyway, why bother with the environment variable? Why not just have a how-to that shows a complete settings file example instead?

[hmpf]

This did not work out of the box, though.

I've never used Django Debug Toolbar at all before, and it seems it's not enough to add some environment variable to make it work in Argus.

I had to put at least these things into my settings file as well, to make Django Debug Toolbar appear:

DEBUG=True

INTERNAL_IPS = [
    "127.0.0.1",
]

DEBUG_TOOLBAR_CONFIG = {
    "ROOT_TAG_EXTRA_ATTRS": "hx-preserve"
}

That INTERNAL_IPS isn't explicitly set the same for everyone is a problem, see #1113. We should probably document it as well.

DEBUG is preferably controlled by an environment variable, hard-coding it anywhere would prevent that.

It works for me without the DEBUG_TOOLBAR_CONFIG-bit but I can't see how adding it will hurt so I have updated the example accordingly.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud