Add comment to settings.dist.py

DefectDojo · May 16, 2024 · e265023 · e265023
1 parent fc05991
commit e265023
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/dojo/settings/.settings.dist.py.sha256sum b/dojo/settings/.settings.dist.py.sha256sum
@@ -1 +1 @@
-6284f6bfa70fc40c9f72fb7cf227b8cdd64ba99b5b56972ae60d1820ef18c5b3
+86a9b26bbb326e3db829374494fe1648489abe5c29233bba63a2c50178782ed3
diff --git a/dojo/settings/settings.dist.py b/dojo/settings/settings.dist.py
@@ -1,3 +1,15 @@
+#########################################################################################################
+# It is not allowed to edit file 'settings.dist.py', for production deployemnts.                        #
+# Any customization of variables need to be done via environmental variables or in 'local_settings.py'. #
+# For more information check https://documentation.defectdojo.com/getting_started/configuration/        #
+#########################################################################################################
+
+#########################################################################################################
+# If as a developer of a new feature, you need to perform an update of file 'settings.dist.py',         #
+# after the change, calculate the checksum and store it related file by calling the following command:  #
+# $ sha256sum settings.dist.py | cut -d ' ' -f1 > .settings.dist.py.sha256sum                           #
+#########################################################################################################
+
 # Django settings for DefectDojo
 import json
 import logging
@@ -14,9 +26,6 @@
 
 logger = logging.getLogger(__name__)
 
-# See https://documentation.defectdojo.com/getting_started/configuration/ for options
-# how to tune the configuration to your needs.
-
 root = environ.Path(__file__) - 3  # Three folders back
 
 # reference: https://pypi.org/project/django-environ/
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		6284f6bfa70fc40c9f72fb7cf227b8cdd64ba99b5b56972ae60d1820ef18c5b3
		86a9b26bbb326e3db829374494fe1648489abe5c29233bba63a2c50178782ed3