From 585b65e11d6ff26d5714db6772e6ca3df09fb0c6 Mon Sep 17 00:00:00 2001 From: Valentin Tolmer Date: Mon, 27 Mar 2023 14:07:28 +0200 Subject: [PATCH] README: Add details about other DBs, migrations --- README.md | 9 +++++++++ docs/architecture.md | 6 +++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5cde870..9615878 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,9 @@ For more features (OAuth/OpenID support, reverse proxy, ...) you can install other components (KeyCloak, Authelia, ...) using this server as the source of truth for users, via LDAP. +By default, the data is stored in SQLite, but you can swap the backend with +MySQL/MariaDB or PostgreSQL. + ## Installation ### With Docker @@ -276,6 +279,12 @@ folder for help with: - [XBackBone](example_configs/xbackbone_config.php) - [Zendto](example_configs/zendto.md) +## Migrating from SQLite + +If you started with an SQLite database and would like to migrate to +MySQL/MariaDB or PostgreSQL, check out the [./docs/database_migration.md](DB +migration docs). + ## Comparisons with other services ### vs OpenLDAP diff --git a/docs/architecture.md b/docs/architecture.md index 9479769..69cc9dd 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -26,9 +26,9 @@ Frontend: Data storage: * The data (users, groups, memberships, active JWTs, ...) is stored in SQL. -* Currently only SQLite is supported (see - https://github.com/launchbadge/sqlx/issues/1225 for what blocks us from - supporting more SQL backends). +* The main SQL DBs are supported: SQLite by default, MySQL, MariaDB, PostgreSQL + (see [./database_migration.md](DB Migration) for how to migrate off of + SQLite). ### Code organization