django-DefectDojo
django-DefectDojo copied to clipboard
Configuration Docs Vagueness
https://defectdojo.github.io/django-DefectDojo/getting_started/configuration/
It has been a bit hard to decipher what exactly needs to be done to configure the system. Those who aren't familiar with docker-compose, docker files, django, and python...etc will have a hard time configuring the service. It is unclear where certain variables need to be placed.
For instance, this paragraph:
When you deploy DefectDojo via Docker Compose, you can set environment variables in docker-compose.yml. Be aware you have to set the variables for three services: uwsgi, celerybeat and celeryworker.
It should specific that you will want to edit ENVIRONMENT section of the yml file (even though it may seem obvious). Also, is it asking to add the environment variable to three of the containers' environment sections, or just uwsgi? Also, it is hard to tell if it is implying that if you set any customizations in one of the containers, you now need to create custom settings for all of them as a result of deviating from "default"?
Without pouring over code it's hard to tell what is actually using X variable.
On top of that, what about the overrides? When is it appropriate to use them, why would you make a symbolic link..etc.
It would be great to update this page for System Admins or IT Teams who are implementing DefectDojo, but who are not developers themselves.