From 098322cef8b3b84fb87ab87c1d262fd11c64d90f Mon Sep 17 00:00:00 2001 From: Philip Molares Date: Wed, 5 Mar 2025 19:22:52 +0100 Subject: [PATCH] docs(database): remove mention of mysql We don't test it, and so we should not tell people HD2 could work with mysql Signed-off-by: Philip Molares --- docs/content/references/config/database.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/content/references/config/database.md b/docs/content/references/config/database.md index 85a0cf629..b6f3b8344 100644 --- a/docs/content/references/config/database.md +++ b/docs/content/references/config/database.md @@ -6,13 +6,16 @@ We officially support and test these databases: - PostgreSQL - MariaDB +!!! warning + We don't necessarily support MySQL. + -| environment variable | default | example | description | -|-----------------------|---------|---------------------|--------------------------------------------------------------------------------------------| -| `HD_DATABASE_TYPE` | - | `postgres` | The database type you want to use. This can be `postgres`, `mysql`, `mariadb` or `sqlite`. | +| environment variable | default | example | description | +|-----------------------|---------|---------------------|----------------------------------------------------------------------------------------| +| `HD_DATABASE_TYPE` | - | `postgres` | The database type you want to use. This can be `postgres`, `mariadb` or `sqlite`. | | `HD_DATABASE_NAME` | - | `hedgedoc` | The name of the database to use. When using SQLite, this is the path to the database file. | -| `HD_DATABASE_HOST` | - | `db.example.com` | The host, where the database runs. *Only if you're **not** using `sqlite`.* | -| `HD_DATABASE_PORT` | - | `5432` | The port, where the database runs. *Only if you're **not** using `sqlite`.* | -| `HD_DATABASE_USER` | - | `hedgedoc` | The user that logs in the database. *Only if you're **not** using `sqlite`.* | -| `HD_DATABASE_PASS` | - | `password` | The password to log into the database. *Only if you're **not** using `sqlite`.* | +| `HD_DATABASE_HOST` | - | `db.example.com` | The host, where the database runs. *Only if you're **not** using `sqlite`.* | +| `HD_DATABASE_PORT` | - | `5432` | The port, where the database runs. *Only if you're **not** using `sqlite`.* | +| `HD_DATABASE_USER` | - | `hedgedoc` | The user that logs in the database. *Only if you're **not** using `sqlite`.* | +| `HD_DATABASE_PASS` | - | `password` | The password to log into the database. *Only if you're **not** using `sqlite`.* |