Close Mailu#2533: document SQLALCHEMY_DATABASE_URI

nextgens · Nov 23, 2022 · de1dc9d · de1dc9d
1 parent 8380621
commit de1dc9d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -287,6 +287,10 @@ The admin service stores configurations in a database.
 - ``DB_USER``: the database user for mailu admin service. (when not ``sqlite``)
 - ``DB_NAME``: the database name for mailu admin service. (when not ``sqlite``)
 
+Alternatively, if you need more control, you can use a `DB URL`_ : do not set any of the ``DB_`` settings and set ``SQLALCHEMY_DATABASE_URI`` instead.
+
+.. _`DB URL`: https://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls
+
 The roundcube service stores configurations in a database.
 
 - ``ROUNDCUBE_DB_FLAVOR``: the database type for roundcube service. (``sqlite``, ``postgresql``, ``mysql``)