Skip to content

Commit f73ab50

Browse files
docs: running in production should change aes key (#12132)
* running in production should change aes key * running in production should change aes key * add instructions on how to generate AES key * adjust celery text
1 parent 08f4201 commit f73ab50

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

docs/content/en/open_source/installation/running-in-production.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,18 @@ With a separate database, the minimum recommendations to run DefectDojo are:
2828
a different disk than your OS\'s for potential performance
2929
improvements.
3030

31+
### Security
32+
Verify the `nginx` configuration and other run-time aspects such as security headers to comply with your compliance requirements.
33+
Change the AES256 encryption key `&91a*agLqesc*0DJ+2*bAbsUZfR*4nLw` in `docker-compose.yml` to something unique for your instance.
34+
This encryption key is used to encrypt API keys and other credentials stored in Defect Dojo to connect to external tools such as SonarQube. A key can be generated in various ways for example using a password manager or `openssl`:
35+
36+
```
37+
openssl rand -base64 32
38+
```
39+
```
40+
DD_CREDENTIAL_AES_256_KEY: "${DD_CREDENTIAL_AES_256_KEY:-<PUT THE GENERATED KEY HERE>o}"
41+
```
42+
3143
## File Backup
3244

3345
In both cases (dedicated DB or containerized), if you are self-hosting, it is recommended that you implement and create periodic backups of your data.
@@ -55,7 +67,7 @@ concurrent connections.
5567

5668
### Celery worker
5769

58-
By default, a single mono-process celery worker is spawned. When storing a large amount of findings, leveraging async functions (like deduplication), or both. Eventually, it is important to adjust these parameters to prevent resource starvation.
70+
By default, a single mono-process celery worker is spawned. When storing a large amount of findings or running large imports it might be helpful to adjust these parameters to prevent resource starvation.
5971

6072
The following variables can be changed to increase worker performance, while keeping a single celery container.
6173

@@ -80,8 +92,8 @@ and see what is in effect.
8092

8193
<span style="background-color:rgba(242, 86, 29, 0.3)">This experimental feature has been deprecated as of DefectDojo 2.44.0 (March release). Please exercise caution if using this feature with an older version of DefectDojo, as results may be inconsistent.</span>
8294

83-
Import and Re-Import can also be configured to handle uploads asynchronously to aid in
84-
processing especially large scans. It works by batching Findings and Endpoints by a
95+
Import and Re-Import can also be configured to handle uploads asynchronously to aid in
96+
processing especially large scans. It works by batching Findings and Endpoints by a
8597
configurable amount. Each batch will be be processed in separate celery tasks.
8698

8799
The following variables impact async imports.
@@ -90,7 +102,7 @@ The following variables impact async imports.
90102
- `DD_ASYNC_FINDING_IMPORT_CHUNK_SIZE` defaults to 100
91103

92104
When using asynchronous imports with dynamic scanners, Endpoints will continue to "trickle" in
93-
even after the import has returned a successful response. This is because processing continues
105+
even after the import has returned a successful response. This is because processing continues
94106
to occur after the Findings have already been imported.
95107

96108
To determine if an import has been fully completed, please see the progress bar in the appropriate test.

0 commit comments

Comments
 (0)