Bot Updating Documentation

images/docker-kimai.md

@@ -42,14 +42,19 @@ The architectures supported by this image are:
 
 You have to replace the following values with your defaults:
 
-- the database username "your_db_user"
+* the database username "your_db_user"
-- the database password "your_db_pass"
+* the database password "your_db_pass"
-- the database schema name "your_db_name"
+* the database schema name "your_db_name"
-- the database host or IP "your_db_host"
+* the database host or IP "your_db_host"
-- you might have to adapt port "3306" as well
+* the database character set "your_db_charset" (usually "utf8")
+* the database version "your_db_version"
+  * run `SELECT VERSION();` in your MariaDB/MySQL database to get the version
+  * example for [MariaDB](https://www.doctrine-project.org/projects/doctrine-dbal/en/current/reference/configuration.html#mariadb) use "10.11.4-MariaDB-log"
+  * example for [MySQL](https://www.doctrine-project.org/projects/doctrine-dbal/en/current/reference/configuration.html#mysql) use "8.0.32"
+* you might have to adapt port "3306" as well
 
 ```env
-DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name
+DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version
 ````
 
 ### Create your first user
@@ -79,7 +84,7 @@ services:
       - PUID=1000
       - PGID=1000
       - TZ=Etc/UTC
-      - DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name
+      - DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version
     volumes:
       - /path/to/appdata/config:/config
     ports:
@@ -116,7 +121,7 @@ docker run -d \
   -e PUID=1000 \
   -e PGID=1000 \
   -e TZ=Etc/UTC \
-  -e DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name \
+  -e DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version \
   -p 80:80 \
   -p 443:443 \
   -v /path/to/appdata/config:/config \
@@ -159,7 +164,7 @@ Docker images are configured using parameters passed at runtime (such as those a
 | `PUID=1000` | for UserID - see below for explanation |
 | `PGID=1000` | for GroupID - see below for explanation |
 | `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
-| `DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name` | Configure your database connection |
+| `DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version` | Configure your database connection, see Application Setup instructions. |
 
 ### Volume Mappings (`-v`)
 
@@ -221,4 +226,5 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
 
 ## Versions
 
+* **21.08.23:** - Important documentation update for setting `DATABASE_URL` with version 2.0.30 and later.
 * **09.08.23:** - Initial Release.