Skip to content

Commit d02dc8c

Browse files
Update config docs (#64)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: dependencytrack-bot <106437498+dependencytrack-bot@users.noreply.github.com>
1 parent 4d2ba35 commit d02dc8c

1 file changed

Lines changed: 8 additions & 161 deletions

File tree

docs/reference/configuration/properties.md

Lines changed: 8 additions & 161 deletions
Original file line numberDiff line numberDiff line change
@@ -298,126 +298,13 @@ Defines the interval in milliseconds in which the database cache provider perfo
298298

299299
## Database
300300

301-
<span id="dtdatabasepassword">**`dt.database.password`** [](#dtdatabasepassword){ .headerlink }</span>
302-
303-
Specifies the password to use when authenticating to the database.
304-
305-
306-
!!! warning "Deprecated"
307-
Since 5.7.0. Use [`dt.datasource.password`](#dtdatasourcepassword) instead.
308-
309-
<table>
310-
<tr><th>Type</th><td style="border-width: 0"><code>string</code></td></tr>
311-
<tr><th>Default</th><td><code>dtrack</code></td></tr>
312-
<tr><th>ENV</th><td><code>DT_DATABASE_PASSWORD</code></td></tr>
313-
</table>
314-
315-
<span id="dtdatabasepoolenabled">**`dt.database.pool.enabled`** [](#dtdatabasepoolenabled){ .headerlink }</span>
316-
317-
Specifies if the database connection pool is enabled.
318-
319-
320-
!!! warning "Deprecated"
321-
Since 5.7.0. Use [`dt.datasource.pool.enabled`](#dtdatasourcepoolenabled) instead.
322-
323-
<table>
324-
<tr><th>Type</th><td style="border-width: 0"><code>boolean</code></td></tr>
325-
<tr><th>Default</th><td><code>true</code></td></tr>
326-
<tr><th>ENV</th><td><code>DT_DATABASE_POOL_ENABLED</code></td></tr>
327-
</table>
328-
329-
<span id="dtdatabasepoolidletimeout">**`dt.database.pool.idle.timeout`** [](#dtdatabasepoolidletimeout){ .headerlink }</span>
330-
331-
This property controls the maximum amount of time that a connection is allowed to sit idle in the pool.
332-
333-
334-
!!! warning "Deprecated"
335-
Since 5.7.0. Use [`dt.datasource.pool.idle-timeout-ms`](#dtdatasourcepoolidle-timeout-ms) instead.
336-
337-
<table>
338-
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
339-
<tr><th>Default</th><td><code>300000</code></td></tr>
340-
<tr><th>ENV</th><td><code>DT_DATABASE_POOL_IDLE_TIMEOUT</code></td></tr>
341-
</table>
342-
343-
<span id="dtdatabasepoolmaxlifetime">**`dt.database.pool.max.lifetime`** [](#dtdatabasepoolmaxlifetime){ .headerlink }</span>
344-
345-
This property controls the maximum lifetime of a connection in the pool. An in-use connection will never be retired, only when it is closed will it then be removed.
346-
347-
348-
!!! warning "Deprecated"
349-
Since 5.7.0. Use [`dt.datasource.pool.max-lifetime-ms`](#dtdatasourcepoolmax-lifetime-ms) instead.
350-
351-
<table>
352-
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
353-
<tr><th>Default</th><td><code>600000</code></td></tr>
354-
<tr><th>ENV</th><td><code>DT_DATABASE_POOL_MAX_LIFETIME</code></td></tr>
355-
</table>
356-
357-
<span id="dtdatabasepoolmaxsize">**`dt.database.pool.max.size`** [](#dtdatabasepoolmaxsize){ .headerlink }</span>
358-
359-
This property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections.
360-
361-
362-
!!! warning "Deprecated"
363-
Since 5.7.0. Use [`dt.datasource.pool.max-size`](#dtdatasourcepoolmax-size) instead.
364-
365-
<table>
366-
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
367-
<tr><th>Default</th><td><code>30</code></td></tr>
368-
<tr><th>ENV</th><td><code>DT_DATABASE_POOL_MAX_SIZE</code></td></tr>
369-
</table>
370-
371-
<span id="dtdatabasepoolminidle">**`dt.database.pool.min.idle`** [](#dtdatabasepoolminidle){ .headerlink }</span>
372-
373-
This property controls the minimum number of idle connections in the pool. This value should be equal to or less than [`dt.database.pool.max.size`](#dtdatabasepoolmaxsize). Warning: If the value is less than [`dt.database.pool.max.size`](#dtdatabasepoolmaxsize), [`dt.database.pool.idle.timeout`](#dtdatabasepoolidletimeout) will have no effect.
374-
375-
376-
!!! warning "Deprecated"
377-
Since 5.7.0. Use [`dt.datasource.pool.min-idle`](#dtdatasourcepoolmin-idle) instead.
378-
379-
<table>
380-
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
381-
<tr><th>Default</th><td><code>15</code></td></tr>
382-
<tr><th>ENV</th><td><code>DT_DATABASE_POOL_MIN_IDLE</code></td></tr>
383-
</table>
384-
385-
<span id="dtdatabaseurl">**`dt.database.url`** [](#dtdatabaseurl){ .headerlink }</span>
386-
387-
Specifies the JDBC URL to use when connecting to the database. For best performance, set the `reWriteBatchedInserts` query parameter to `true`.
388-
389-
390-
!!! warning "Deprecated"
391-
Since 5.7.0. Use [`dt.datasource.url`](#dtdatasourceurl) instead.
392-
393-
<table>
394-
<tr><th>Type</th><td style="border-width: 0"><code>string</code></td></tr>
395-
<tr><th>Default</th><td><code>null</code></td></tr>
396-
<tr><th>Example</th><td><code>jdbc:postgresql://localhost:5432/dtrack?reWriteBatchedInserts=true</code></td></tr>
397-
<tr><th>ENV</th><td><code>DT_DATABASE_URL</code></td></tr>
398-
</table>
399-
400-
<span id="dtdatabaseusername">**`dt.database.username`** [](#dtdatabaseusername){ .headerlink }</span>
401-
402-
Specifies the username to use when authenticating to the database.
403-
404-
405-
!!! warning "Deprecated"
406-
Since 5.7.0. Use [`dt.datasource.username`](#dtdatasourceusername) instead.
407-
408-
<table>
409-
<tr><th>Type</th><td style="border-width: 0"><code>string</code></td></tr>
410-
<tr><th>Default</th><td><code>dtrack</code></td></tr>
411-
<tr><th>ENV</th><td><code>DT_DATABASE_USERNAME</code></td></tr>
412-
</table>
413-
414301
<span id="dtdatasourcepassword">**`dt.datasource.password`** [](#dtdatasourcepassword){ .headerlink }</span>
415302

416303
Defines the password to use for the default data source.
417304

418305
<table>
419306
<tr><th>Type</th><td style="border-width: 0"><code>string</code></td></tr>
420-
<tr><th>Default</th><td><code>${dt.database.password}</code></td></tr>
307+
<tr><th>Default</th><td><code>dtrack</code></td></tr>
421308
<tr><th>ENV</th><td><code>DT_DATASOURCE_PASSWORD</code></td></tr>
422309
</table>
423310

@@ -427,7 +314,7 @@ Defines whether connection pooling is enabled for the default data source.
427314

428315
<table>
429316
<tr><th>Type</th><td style="border-width: 0"><code>boolean</code></td></tr>
430-
<tr><th>Default</th><td><code>${dt.database.pool.enabled}</code></td></tr>
317+
<tr><th>Default</th><td><code>true</code></td></tr>
431318
<tr><th>ENV</th><td><code>DT_DATASOURCE_POOL_ENABLED</code></td></tr>
432319
</table>
433320

@@ -437,7 +324,7 @@ Defines the maximum time in milliseconds that a connection is allowed to sit idl
437324

438325
<table>
439326
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
440-
<tr><th>Default</th><td><code>${dt.database.pool.idle.timeout}</code></td></tr>
327+
<tr><th>Default</th><td><code>300000</code></td></tr>
441328
<tr><th>ENV</th><td><code>DT_DATASOURCE_POOL_IDLE_TIMEOUT_MS</code></td></tr>
442329
</table>
443330

@@ -447,7 +334,7 @@ Defines the maximum time in milliseconds for which connections should be kept in
447334

448335
<table>
449336
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
450-
<tr><th>Default</th><td><code>${dt.database.pool.max.lifetime}</code></td></tr>
337+
<tr><th>Default</th><td><code>600000</code></td></tr>
451338
<tr><th>ENV</th><td><code>DT_DATASOURCE_POOL_MAX_LIFETIME_MS</code></td></tr>
452339
</table>
453340

@@ -457,7 +344,7 @@ Defines the maximum size of the connection pool for the default data source. Re
457344

458345
<table>
459346
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
460-
<tr><th>Default</th><td><code>${dt.database.pool.max.size}</code></td></tr>
347+
<tr><th>Default</th><td><code>30</code></td></tr>
461348
<tr><th>ENV</th><td><code>DT_DATASOURCE_POOL_MAX_SIZE</code></td></tr>
462349
</table>
463350

@@ -467,7 +354,7 @@ Defines the minimum number of idle connections in the pool for the default data
467354

468355
<table>
469356
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
470-
<tr><th>Default</th><td><code>${dt.database.pool.min.idle}</code></td></tr>
357+
<tr><th>Default</th><td><code>15</code></td></tr>
471358
<tr><th>ENV</th><td><code>DT_DATASOURCE_POOL_MIN_IDLE</code></td></tr>
472359
</table>
473360

@@ -477,7 +364,7 @@ Defines the JDBC URL to use for the default data source.
477364

478365
<table>
479366
<tr><th>Type</th><td style="border-width: 0"><code>string</code></td></tr>
480-
<tr><th>Default</th><td><code>${dt.database.url}</code></td></tr>
367+
<tr><th>Default</th><td><code>null</code></td></tr>
481368
<tr><th>Example</th><td><code>jdbc:postgresql://localhost:5432/dtrack?reWriteBatchedInserts=true</code></td></tr>
482369
<tr><th>ENV</th><td><code>DT_DATASOURCE_URL</code></td></tr>
483370
</table>
@@ -488,7 +375,7 @@ Defines the username to use for the default data source.
488375

489376
<table>
490377
<tr><th>Type</th><td style="border-width: 0"><code>string</code></td></tr>
491-
<tr><th>Default</th><td><code>${dt.database.username}</code></td></tr>
378+
<tr><th>Default</th><td><code>dtrack</code></td></tr>
492379
<tr><th>ENV</th><td><code>DT_DATASOURCE_USERNAME</code></td></tr>
493380
</table>
494381

@@ -1261,26 +1148,6 @@ Defines the connection timeout in seconds for outbound HTTP connections.
12611148
<tr><th>ENV</th><td><code>DT_HTTP_TIMEOUT_CONNECTION</code></td></tr>
12621149
</table>
12631150

1264-
<span id="dthttptimeoutpool">**`dt.http.timeout.pool`** [](#dthttptimeoutpool){ .headerlink }</span>
1265-
1266-
Defines the request timeout in seconds for outbound HTTP connections.
1267-
1268-
<table>
1269-
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
1270-
<tr><th>Default</th><td><code>60</code></td></tr>
1271-
<tr><th>ENV</th><td><code>DT_HTTP_TIMEOUT_POOL</code></td></tr>
1272-
</table>
1273-
1274-
<span id="dthttptimeoutsocket">**`dt.http.timeout.socket`** [](#dthttptimeoutsocket){ .headerlink }</span>
1275-
1276-
Defines the socket / read timeout in seconds for outbound HTTP connections.
1277-
1278-
<table>
1279-
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
1280-
<tr><th>Default</th><td><code>30</code></td></tr>
1281-
<tr><th>ENV</th><td><code>DT_HTTP_TIMEOUT_SOCKET</code></td></tr>
1282-
</table>
1283-
12841151
<span id="dtnoproxy">**`dt.no.proxy`** [](#dtnoproxy){ .headerlink }</span>
12851152

12861153

@@ -2335,16 +2202,6 @@ Defines whether the OSS Index vulnerability analyzer is allowed to connect to lo
23352202
<tr><th>ENV</th><td><code>DT_VULN_ANALYZER_OSS_INDEX_ALLOW_LOCAL_CONNECTIONS</code></td></tr>
23362203
</table>
23372204

2338-
<span id="dtvuln-analyzeross-indexenabled">**`dt.vuln-analyzer.oss-index.enabled`** [](#dtvuln-analyzeross-indexenabled){ .headerlink }</span>
2339-
2340-
Defines whether the OSS Index vulnerability analyzer is enabled.
2341-
2342-
<table>
2343-
<tr><th>Type</th><td style="border-width: 0"><code>boolean</code></td></tr>
2344-
<tr><th>Default</th><td><code>true</code></td></tr>
2345-
<tr><th>ENV</th><td><code>DT_VULN_ANALYZER_OSS_INDEX_ENABLED</code></td></tr>
2346-
</table>
2347-
23482205
<span id="dtvuln-analyzersnykapi-version">**`dt.vuln-analyzer.snyk.api-version`** [](#dtvuln-analyzersnykapi-version){ .headerlink }</span>
23492206

23502207
Defines the Snyk REST API version to use. <br/><br/> Should only be changed if the default version is discontinued by Snyk and an upgrade of Dependency-Track is not immediately possible.
@@ -2355,14 +2212,4 @@ Defines the Snyk REST API version to use. <br/><br/> Should only be changed if
23552212
<tr><th>ENV</th><td><code>DT_VULN_ANALYZER_SNYK_API_VERSION</code></td></tr>
23562213
</table>
23572214

2358-
<span id="dtvuln-analyzersnykenabled">**`dt.vuln-analyzer.snyk.enabled`** [](#dtvuln-analyzersnykenabled){ .headerlink }</span>
2359-
2360-
Defines whether the Snyk vulnerability analyzer is enabled.
2361-
2362-
<table>
2363-
<tr><th>Type</th><td style="border-width: 0"><code>boolean</code></td></tr>
2364-
<tr><th>Default</th><td><code>true</code></td></tr>
2365-
<tr><th>ENV</th><td><code>DT_VULN_ANALYZER_SNYK_ENABLED</code></td></tr>
2366-
</table>
2367-
23682215

0 commit comments

Comments
 (0)