Skip to content

Commit

Permalink
Update database support docs
Browse files Browse the repository at this point in the history
* 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 <nscuro@protonmail.com>
  • Loading branch information
nscuro committed Jun 1, 2024
1 parent 3af6f5a commit 5f185c3
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
5 changes: 5 additions & 0 deletions docs/_docs/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions docs/_docs/getting-started/database-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,19 @@ 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.
Both PostgreSQL and SQL Server have been proven to work very well in production deployments, while
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
Expand Down
5 changes: 5 additions & 0 deletions src/main/resources/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5f185c3

Please sign in to comment.