Skip to content

Commit f4e1aef

Browse files
sso docs: make environment variables vs local_settings more explicit
1 parent 83b3607 commit f4e1aef

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

docs/content/en/customize_dojo/user_management/configure_sso.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ When a user is removed from a given group in Azure AD, they will also be removed
141141

142142
### Open-Source
143143

144-
Open-Source users will need to set these variables as an environment variable, or in the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
144+
Open-Source users will need to set these variables as an environment variable, or without the `DD_` prefix in the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
145145

146-
1. Add the following information to the settings file:
146+
1. Set the following environment variables
147147

148148
{{< highlight python >}}
149149
DD_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_KEY=(str, 'YOUR_APPLICATION_ID_FROM_STEP_ABOVE'),
@@ -213,9 +213,9 @@ Both <span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Pro</span>
213213

214214
### Open-Source
215215

216-
Open-Source users will need to set these fields as Docker environment variables, or add them to the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
216+
Open-Source users will need to set these variables as an environment variable, or without the `DD_` prefix in the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
217217

218-
1. Add the following variables to Docker, or to local_settings.py:
218+
1. Set the following environment variables
219219
{{< highlight python >}}
220220
DD_SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY=(str, 'GitHub Enterprise OAuth App Client ID'),
221221
DD_SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET=(str, 'GitHub Enterprise OAuth App Client Secret'),
@@ -259,9 +259,9 @@ Follow along below.
259259

260260
### Open-Source
261261

262-
Open-Source users will need to set these fields as Docker environment variables, or add them to the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
262+
Open-Source users will need to set these variables as an environment variable, or without the `DD_` prefix in the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
263263

264-
1. Add the following variables to Docker, or to the `local_settings.py` file:
264+
1. Set the following environment variables
265265
{{< highlight python >}}
266266
DD_SOCIAL_AUTH_GITLAB_KEY=(str, 'YOUR_APPLICATION_ID_FROM_STEP_ABOVE'),
267267
DD_SOCIAL_AUTH_GITLAB_SECRET=(str, 'YOUR_SECRET_FROM_STEP_ABOVE'),
@@ -320,9 +320,9 @@ In order to use Google Authentication, a Google Authentication Server will need
320320

321321
### Open-Source
322322

323-
Open-Source users will need to set these fields as Docker environment variables, or add them to the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
323+
Open-Source users will need to set these variables as an environment variable, or without the `DD_` prefix in the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
324324

325-
1. Add the following variables to Docker, or to the `local_settings.py` file:
325+
1. Set the following environment variables
326326

327327
{{< highlight python >}}
328328
DD_SOCIAL_AUTH_GOOGLE_OAUTH2_ENABLED=True,
@@ -404,9 +404,11 @@ This guide assumes you already have a KeyCloak Realm set up. If not, you will n
404404
### Open-Source
405405

406406

407-
Open-Source users will need to set these fields as Docker environment variables, or add them to the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
407+
Open-Source users will need to set these variables as an environment variable, or without the `DD_` prefix in the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
408408

409-
1. {{< highlight python >}}
409+
1. Set the following environment variables
410+
411+
{{< highlight python >}}
410412
DD_SESSION_COOKIE_SECURE=True,
411413
DD_CSRF_COOKIE_SECURE=True,
412414
DD_SECURE_SSL_REDIRECT=True,
@@ -490,7 +492,9 @@ Both <span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Pro</span>
490492

491493
### Open-Source
492494

493-
1. Open-Source users will need to set these fields as Docker environment variables, or add them to the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
495+
Open-Source users will need to set these variables as an environment variable, or without the `DD_` prefix in the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
496+
497+
1. Set the following environment variables
494498

495499
{{< highlight python >}}
496500
DD_SOCIAL_AUTH_OKTA_OAUTH2_ENABLED=True,
@@ -504,7 +508,7 @@ If during the login process you get the following error: *The
504508
in the client app settings.* and the `redirect_uri` HTTP
505509
GET parameter starts with `http://` instead of
506510
`https://` you need to add
507-
`SOCIAL_AUTH_REDIRECT_IS_HTTPS = True` to Docker environment variables, or to your local_settings.py file.
511+
`SOCIAL_AUTH_REDIRECT_IS_HTTPS = True` to Docker environment variables, or to your `local_settings.py` file.
508512

509513
2. Restart DefectDojo, and 'Login With Okta' should appear on the login screen.
510514

@@ -559,7 +563,7 @@ The left side of the ‘=’ sign represents the attribute you want to map from
559563
### Open-Source SAML
560564

561565
1. Navigate to your SAML IdP and find your metadata.
562-
2. Set these fields as Docker environment variables, or add them to the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
566+
2. Set these variables as an environment variable, or without the `DD_` prefix in the `local_settings.py` file. (see [Configuration](/en/open_source/installation/configuration)).
563567

564568
{{< highlight python >}}
565569
DD_SAML2_ENABLED=(bool, **True**),

0 commit comments

Comments
 (0)