From 5f185c309087b0ac9a4730e870c5c0124b206fa7 Mon Sep 17 00:00:00 2001 From: nscuro Date: Wed, 15 May 2024 21:44:49 +0200 Subject: [PATCH] Update database support docs * Raise supported versions for PostgreSQL and SQL Server to non-EOL versions * Add notice about deprecation of RDBMSes other than PostgreSQL in DT v5 Signed-off-by: nscuro --- docs/_docs/getting-started/configuration.md | 5 +++++ docs/_docs/getting-started/database-support.md | 8 ++++++-- src/main/resources/application.properties | 5 +++++ 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/_docs/getting-started/configuration.md b/docs/_docs/getting-started/configuration.md index a3ac42f378..308ac78d0c 100644 --- a/docs/_docs/getting-started/configuration.md +++ b/docs/_docs/getting-started/configuration.md @@ -115,6 +115,11 @@ alpine.database.username=sa # Specifies the password to use when authenticating to the database. # alpine.database.password= +# Optional +# Specifies a path to the file holding the database password. +# To be used as alternative to alpine.database.password. +# alpine.database.password.file= + # Optional # Specifies if the database connection pool is enabled. alpine.database.pool.enabled=true diff --git a/docs/_docs/getting-started/database-support.md b/docs/_docs/getting-started/database-support.md index 0b61053404..a2c8aedbbb 100644 --- a/docs/_docs/getting-started/database-support.md +++ b/docs/_docs/getting-started/database-support.md @@ -14,8 +14,8 @@ Dependency-Track supports the following database servers: | RDBMS | Supported Versions | Recommended | |:---------------------|:-------------------|:------------| -| PostgreSQL | >= 9.0 | ✅ | -| Microsoft SQL Server | >= 2012 | ✅ | +| PostgreSQL | >= 12.0 | ✅ | +| Microsoft SQL Server | >= 2017 | ⚠️ | | MySQL | 5.6 - 5.7 | ❌ | Dependency-Track requires extensive unicode support, which is not provided per default in MySQL. @@ -23,6 +23,10 @@ Both PostgreSQL and SQL Server have been proven to work very well in production MySQL / MariaDB can require [lots of extra care](https://github.com/DependencyTrack/dependency-track/issues/271#issuecomment-1108923693). **Only use MySQL if you know what you're doing**! +> Support for H2, Microsoft SQL Server, and MySQL will be dropped in Dependency-Track v5. +> From then onwards, the project will focus on PostgreSQL. When setting up a new instance +> of Dependency-Track v4.x, consider using PostgreSQL. + Refer to the [Configuration] documentation for how database settings may be changed. ### Examples diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index 9b3aba9a61..a6f5fa53a8 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -81,6 +81,11 @@ alpine.database.username=sa # Specifies the password to use when authenticating to the database. # alpine.database.password= +# Optional +# Specifies a path to the file holding the database password. +# To be used as alternative to alpine.database.password. +# alpine.database.password.file= + # Optional # Specifies if the database connection pool is enabled. alpine.database.pool.enabled=true