Skip to content

Commit c2fae96

Browse files
authored
Merge pull request #2109 from DependencyTrack/update-config-docs
Update config docs
2 parents ce47646 + ee3c9c5 commit c2fae96

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/reference/configuration/api-server.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1050,6 +1050,15 @@ Configuration properties may use the following types:
10501050
<tr><th>ENV</th><td><code>DT_INIT_TASKS_ENABLED</code></td></tr>
10511051
</table>
10521052

1053+
<span id="dttelemetrysubmissionenableddefault">**`dt.telemetry.submission.enabled.default`** [](#dttelemetrysubmissionenableddefault){ .headerlink }</span>
1054+
: Defines the default value for the telemetry submission enabled setting. <br/><br/> This is only used during initial database seeding. Once the setting exists in the database, it can be toggled via the REST API or the admin UI. <br/><br/> To opt out of telemetry before first startup, set this to `false`.
1055+
1056+
<table>
1057+
<tr><th>Type</th><td style="border-width: 0"><code>boolean</code></td></tr>
1058+
<tr><th>Default</th><td><code>true</code></td></tr>
1059+
<tr><th>ENV</th><td><code>DT_TELEMETRY_SUBMISSION_ENABLED_DEFAULT</code></td></tr>
1060+
</table>
1061+
10531062
<span id="dttmpdelaybomprocessednotification">**`dt.tmp.delay.bom.processed.notification`** [](#dttmpdelaybomprocessednotification){ .headerlink }</span>
10541063
: Delays the BOM_PROCESSED notification until the vulnerability analysis associated with a given BOM upload is completed. The intention being that it is then "safe" to query the API for any identified vulnerabilities. This is specifically for cases where polling the /api/v1/bom/token/<TOKEN> endpoint is not feasible. THIS IS A TEMPORARY FUNCTIONALITY AND MAY BE REMOVED IN FUTURE RELEASES WITHOUT FURTHER NOTICE.
10551064

@@ -2089,7 +2098,7 @@ Configuration properties may use the following types:
20892098
<tr><th>ENV</th><td><code>DT_TASK_PACKAGE_METADATA_MAINTENANCE_LOCK_MIN_DURATION</code></td></tr>
20902099
</table>
20912100

2092-
<span id="dttaskportfoliometricsupdatecron">**`dt.task.portfolio.metrics.update.cron`** <strong style="color: red">*</strong> [](#dttaskportfoliometricsupdatecron){ .headerlink }</span>
2101+
<span id="dttaskportfolio-metrics-updatecron">**`dt.task.portfolio-metrics-update.cron`** <strong style="color: red">*</strong> [](#dttaskportfolio-metrics-updatecron){ .headerlink }</span>
20932102
: Cron expression of the portfolio metrics update task.
20942103

20952104
<table>
@@ -2098,24 +2107,6 @@ Configuration properties may use the following types:
20982107
<tr><th>ENV</th><td><code>DT_TASK_PORTFOLIO_METRICS_UPDATE_CRON</code></td></tr>
20992108
</table>
21002109

2101-
<span id="dttaskportfoliometricsupdatelockmaxduration">**`dt.task.portfolio.metrics.update.lock.max.duration`** <strong style="color: red">*</strong> [](#dttaskportfoliometricsupdatelockmaxduration){ .headerlink }</span>
2102-
: Maximum duration in ISO 8601 format for which the portfolio metrics update task will hold a lock. <br/><br/> The duration should be long enough to cover the task's execution duration.
2103-
2104-
<table>
2105-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
2106-
<tr><th>Default</th><td><code>PT15M</code></td></tr>
2107-
<tr><th>ENV</th><td><code>DT_TASK_PORTFOLIO_METRICS_UPDATE_LOCK_MAX_DURATION</code></td></tr>
2108-
</table>
2109-
2110-
<span id="dttaskportfoliometricsupdatelockminduration">**`dt.task.portfolio.metrics.update.lock.min.duration`** <strong style="color: red">*</strong> [](#dttaskportfoliometricsupdatelockminduration){ .headerlink }</span>
2111-
: Minimum duration in ISO 8601 format for which the portfolio metrics update task will hold a lock. <br/><br/> The duration should be long enough to cover eventual clock skew across API server instances.
2112-
2113-
<table>
2114-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
2115-
<tr><th>Default</th><td><code>PT90S</code></td></tr>
2116-
<tr><th>ENV</th><td><code>DT_TASK_PORTFOLIO_METRICS_UPDATE_LOCK_MIN_DURATION</code></td></tr>
2117-
</table>
2118-
21192110
<span id="dttaskprojectmaintenancecron">**`dt.task.project.maintenance.cron`** <strong style="color: red">*</strong> [](#dttaskprojectmaintenancecron){ .headerlink }</span>
21202111
: Cron expression of the project maintenance task. <br/><br/> The task deletes inactive projects based on retention policy.
21212112

@@ -2170,6 +2161,15 @@ Configuration properties may use the following types:
21702161
<tr><th>ENV</th><td><code>DT_TASK_TAG_MAINTENANCE_LOCK_MIN_DURATION</code></td></tr>
21712162
</table>
21722163

2164+
<span id="dttasktelemetry-submissioncron">**`dt.task.telemetry-submission.cron`** <strong style="color: red">*</strong> [](#dttasktelemetry-submissioncron){ .headerlink }</span>
2165+
: Cron expression of the telemetry submission task. <br/><br/> The task enforces a 24-hour minimum interval between submissions, so the cron expression controls how often the task checks whether a submission is due.
2166+
2167+
<table>
2168+
<tr><th>Type</th><td style="border-width: 0"><code>cron</code></td></tr>
2169+
<tr><th>Default</th><td><code>0 */1 * * *</code></td></tr>
2170+
<tr><th>ENV</th><td><code>DT_TASK_TELEMETRY_SUBMISSION_CRON</code></td></tr>
2171+
</table>
2172+
21732173
<span id="dttaskvulnerabilityanalysiscron">**`dt.task.vulnerability.analysis.cron`** <strong style="color: red">*</strong> [](#dttaskvulnerabilityanalysiscron){ .headerlink }</span>
21742174
: Cron expression of the portfolio vulnerability analysis task.
21752175

0 commit comments

Comments
 (0)