From bb195a77b8d3f68b8c02033651bd8559c024a905 Mon Sep 17 00:00:00 2001 From: Oliver Date: Mon, 21 Sep 2026 08:17:04 +1000 Subject: [PATCH] Min db docs (#12897) * Add minimum version information * Update DB docs --- docs/docs/start/config.md | 6 ++++++ docs/docs/start/docker.md | 2 +- docs/docs/start/install.md | 6 ++++++ docs/mkdocs.yml | 3 +++ 4 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/docs/start/config.md b/docs/docs/start/config.md index f71cb3cd1d..de4ec4a3e1 100644 --- a/docs/docs/start/config.md +++ b/docs/docs/start/config.md @@ -270,6 +270,8 @@ The following database options can be configured: ### PostgreSQL Settings +InvenTree requires a minimum PostgreSQL version of {{ config.extra.min_postgres_version }}. + If running with a PostgreSQL database backend, the following additional options are available: {{ configtable() }} @@ -287,6 +289,8 @@ If running with a PostgreSQL database backend, the following additional options ### MySQL Settings +InvenTree requires a minimum MySQL version of {{ config.extra.min_mysql_version }}. + If running with a MySQL database backend, the following additional options are available: {{ configtable() }} @@ -295,6 +299,8 @@ If running with a MySQL database backend, the following additional options are a ### SQLite Settings +InvenTree requires a minimum SQLite version of {{ config.extra.min_sqlite_version }}. + !!! warning "SQLite Performance" SQLite is not recommended for production use, and should only be used for testing or development purposes. If you are using SQLite in production, you may want to adjust the following settings to improve performance. diff --git a/docs/docs/start/docker.md b/docs/docs/start/docker.md index a4cdbe3fc1..d3b6ca9696 100644 --- a/docs/docs/start/docker.md +++ b/docs/docs/start/docker.md @@ -123,7 +123,7 @@ Connecting to a different database container is entirely possible, but requires #### Postgres Version -The `inventree-server` and `inventree-worker` containers support connection to a postgres database up to (and including) version {{ config.extra.docker_postgres_version }}. +The `inventree-server` and `inventree-worker` containers support connection to a postgres database from version {{ config.extra.min_postgres_version }} up to (and including) version {{ config.extra.docker_postgres_version }}. !!! warning "Newer Postgres Versions" The InvenTree docker image supports connection to a postgres database up to version {{ config.extra.docker_postgres_version }}. Connecting to a database using a newer version of postgres is not guaranteed. diff --git a/docs/docs/start/install.md b/docs/docs/start/install.md index dade58355f..87ddf28ce9 100644 --- a/docs/docs/start/install.md +++ b/docs/docs/start/install.md @@ -140,6 +140,9 @@ As part of the initial setup, an empty database needs to be created. Follow the ### PostgreSQL +!!! info "Minimum Version" + InvenTree requires a minimum PostgreSQL version of {{ config.extra.min_postgres_version }}. + #### Install PostgreSQL Install required system packages: @@ -186,6 +189,9 @@ sudo apt-get install postgresql-client ### MySQL / MariaDB +!!! info "Minimum Version" + InvenTree requires a minimum MySQL version of {{ config.extra.min_mysql_version }}. + #### Install Backend To run InvenTree with the MySQL or MariaDB backends, a number of extra packages need to be installed: diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 11f6b9e40a..8ba14dcd79 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -384,6 +384,9 @@ extra: min_invoke_version: 2.0.0 django_version: 5.2 docker_postgres_version: 17 + min_postgres_version: 14 + min_mysql_version: 8.0.11 + min_sqlite_version: 3.31.0 version: default: stable