設定 (Open Source)

dojo/settings/settings.dist.py#

主要な設定はdojo/settings/settings.dist.pyに保存されています。このファイルは、何を設定できるかを確認するための参考として使用するには最適ですが、DefectDojoの更新時に変更が上書きされてしまうため、直接編集すべきではありません。デフォルト設定を変更する方法はいくつかあります。

環境変数#

ほとんどのパラメータは環境変数で設定できます。

Docker Composeを使ってDefectDojoをデプロイする場合、docker-compose.ymlで環境変数を設定できます。uwsgi、celerybeat、celeryworkerという3つのサービスすべてに対して変数を設定する必要がある点に注意してください。

KubernetesクラスターにDefectDojoをデプロイする場合、helm/defectdojo/values.yaml内のextraConfigsおよびextraSecretsとして環境変数を設定できます。

環境ファイル(Docker ComposeまたはKubernetesを使用しない場合)#

settings.dist.pyは、環境変数DD_ENV_PATHで指定された名前のファイルから環境変数を読み込みます。この変数が設定されていない場合、デフォルトの.env.prodが使用されます。このファイルはdojo/settingsディレクトリに配置する必要があります。

例はtemplate_envにあります。

local_settings.py#

local_settings.pyには、MIDDLEWAREやINSTALLED_APPのエントリの追加など、より複雑なカスタマイズを含めることができます。 このファイルはsettings.dist.pyが処理された後に処理されるため、DefectDojoが標準で提供する設定を変更できます。 このファイルはdojo/settingsディレクトリに配置する必要があります。このファイル内の環境変数にはDD_プレフィックスを付けてはいけません。 ファイルが存在しない場合は、自由に作成してください。settings.dist.pyを直接編集しないでください。

例はdojo/settings/template-local_settingsにあります。

Docker Composeのリリースモードでは、docker/extra_settings/(docker-compose.ymlファイルからの相対パス)内のファイルが、起動時にdockerコンテナ内のdojo/settings/にコピーされます。

local_settings.pyはKubernetesでも使用できます。変数localsettingspyはConfigMapとして保存され、コンテナの該当する場所にマウントされます。

UIでの設定#

スーパーユーザー権限を持つユーザーは、UIのConfiguration / System Settingsから、さらに多くのオプションを設定できます。