2064: Documentation for switching database-backend and for migrating from Mailu PostgreSQL r=mergify[bot] a=Diman0
## What type of PR?
Documentation
## What does this PR do?
Added documentation for how to switch the database back-end used by Mailu.
Added documentation for migrating from the deprecated Mailu PostgreSQL image to a different PostgreSQL database.
### Related issue(s)
- closes#1037
- closes#1216
- closes#1675
## Prerequisites
Before we can consider review and merge, please make sure the following list is done and checked.
If an entry in not applicable, you can check it or remove it from the list.
- [x] In case of feature or enhancement: documentation updated accordingly
- [x] Unless it's docs or a minor change: add [changelog](https://mailu.io/master/contributors/workflow.html#changelog) entry file.
Co-authored-by: Dimitri Huisman <diman@huisman.xyz>
By default Mailu uses a SQLite database. Recently, we have changed the internals of Mailu
By default Mailu uses a SQLite database. We have changed the internals of Mailu
to enable the support of alternative database solutions as postgresql and mysql/mariadb.
to enable the support of alternative database solutions such as PostgreSQL and MySQL/MariaDB.
This functionality should still be considered experimental!
Mailu Postgresql
----------------
Mailu optionally comes with a pre-configured Postgresql image, which as of 1.8, is deprecated
Migrating to a different database back-end
and will be removed in 1.9.
------------------------------------------
This images has the following features:
- Automatic creation of users, db, extensions and password;
From Mailu 1.9, Mailu has a :ref:`cli command (link) <config-export>` for exporting and importing the complete Mailu configuration.
- TCP connections are only allowed from the mailu `SUBNET`;
Using this tool it is very easy to switch what database back-end is used for Mailu.
- Automatic minutely *wal archiving* and weekly `pg_basebackup`;
Unfortunately roundcube does not have a tool for exporting/importing its configuration.
- Automatic cleaning of *wal archives* and *base backups*;
This means it is not possible to switch the database back-end used by roundcube using out of box tools.
Two versions always remain available;
- When `/data` is empty and backups are present, the backups are restored automatically;
Useful in swarm environments, since the /data directory should not be on any network
filesystem (performance).
To make use of this functionality, just select `postgresql` as database flavor.
To switch to a different database back-end:
Don't select the usage of an external database. The ``docker-compose.yml`` and ``mailu.env``
will pull in ``mailu/postgresql``. This image and ``mailu/admin`` contain all the scripts
to automatically setup the database.
After bring up the service, it might be useful to check the logs with:
1. Run config-export to export the configuration. E.g. `docker-compose exec admin flask mailu config-export --secrets --output mail-config.yml`
2. Set up your new database server. Refer to the subsequent sections for tips for creating the database.
3. Modify the database settings (DB_*) in mailu.env. Refer to the :ref:`configuration guide (link) <db_settings>` for the exact settings.
4. Start your Mailu deployment.
5. Run config-import to import the configuration. E.g. `docker exec -i $(docker-compose ps -q admin) flask mailu config-import -v < mail-config.yml`
..code-block:: bash
Mailu has now been switched to the new database back-end. The Mailu configuration has also been migrated.
docker-compose logs -f admin database
..note::
The setup configuration wizard (setup.mailu.io) only supports creating config files for the same database back-end. When creating new config files, select the desired database flavour in the setup and enter dummy values for roundcube.
In the generated mailu.env file, configure all ROUNDCUBE_DB_* environment variables to the old values. For SQLite you can remove all the ROUNDCUBE_DB_* values.
External Postgresql
External MySQL/MariaDB
----------------------
It is also possible to use a MySQL/MariaDB database server, hosted elsewhere.
In this case you'll have to take to create an empty database for Mailu, corresponding user,
password and sufficient privileges on the database to ``CREATE TABLE``, ``DROP`` etc.
Usually making the user owner of the database would be the easiest thing to do.
The following commands can serve as an example on how to set up MySQL/MariaDB for Mailu usage.
Adjust this to your own liking.
..code-block:: sql
mysql> CREATE DATABASE mailu;
mysql> CREATE USER `mailu`@`%` IDENTIFIED WITH mysql_native_password BY `my-strong-password-here`;
mysql> GRANT ALL PRIVILEGES ON mailu.* TO 'mailu'@'%';
mysql> FLUSH PRIVILEGES;
External PostgreSQL
-------------------
-------------------
It is also possible to use a Postgresql database server, hosted elsewhere.
It is also possible to use a PostgreSQL database server, hosted elsewhere.
In this case you'll have to take to create an empty database for Mailu, corresponding user,
In this case you'll have to take to create an empty database for Mailu, corresponding user,
password and sufficient privileges on the database to ``CREATE TABLE``, ``DROP`` etc.
password and sufficient privileges on the database to ``CREATE TABLE``, ``DROP`` etc.
Usually making the user owner of the database would be the easiest thing to do.
Usually making the user owner of the database would be the easiest thing to do.
Don't forget to set ``pg_hba.conf`` accordingly.
Don't forget to set ``pg_hba.conf`` accordingly.
The following commands can serve as an example on how to set up postgresql for Mailu usage.
The following commands can serve as an example on how to set up PostgreSQL for Mailu usage.
Adjust this to your own liking.
Adjust this to your own liking.
..code-block:: bash
..code-block:: bash
@ -72,42 +87,130 @@ In ``pg_hba.conf`` there should be a line like this:
Note that this example is the bare-minimum to get Mailu working. It goes without saying that
Note that this example is the bare-minimum to get Mailu working. It goes without saying that
the database admin will have to setup his own means of backups and TLS encrypted connections.
the database admin will have to setup his own means of backups and TLS encrypted connections.
External MySQL/Mariadb
Nowadays it is recommended to use the official PostgreSQL image from the PostgreSQL community. The repository is located `here <https://hub.docker.com/_/postgres>`_.
----------------------
It is also possible to use a mysql/mariadb database server, hosted elsewhere.
.._migrate_mailu_postgresql:
In this case you'll have to take to create an empty database for Mailu, corresponding user,
password and sufficient privileges on the database to ``CREATE TABLE``, ``DROP`` etc.
Usually making the user owner of the database would be the easiest thing to do.
The following commands can serve as an example on how to set up mysql/mariadb for Mailu usage.
Mailu PostgreSQL
Adjust this to your own liking.
----------------
..code-block:: sql
Mailu optionally came with a pre-configured PostgreSQL image which was deprecated in Mailu 1.8.
Since Mailu 1.9 it is removed from Mailu. The following section describes how to move to a different PostgreSQL image for novice administrators. The official PostgreSQL image (Postgres) will be used.
mysql> CREATE DATABASE mailu;
A Mailu deployment with the Mailu PostgreSQL image, only used PostgreSQL for the Admin container (Web administration interface). Roundcube used SQLite as database back-end.
mysql> CREATE USER 'mailu'@'%' IDENTIFIED BY 'my-strong-password-here';
Mailu uses the following configuration for connecting to the database:
mysql> GRANT ALL PRIVILEGES ON mailu.* TO 'mailu'@'%';
mysql> FLUSH PRIVILEGES;
Note that if you get any errors related to ``caching_sha2_password`` it can be solved by changing the encryption
of the password to ``mysql_native_password`` instead of the latest authentication plugin ``caching_sha2_password``.
..code-block:: sql
- Database host: 'database'
- Database name: 'mailu'
- Database user: 'mailu'
- Database password: See DB_PW in mailu.env.
mysql> SELECT host, user, plugin FROM mysql.user;
..note::
+-----------+-------+-----------------------+
The following instructions assume that
| host | user | plugin |
- project mailu is used. (-p mailu). If a different project (prefix) is used, then a different project can be specified.
+-----------+-------+-----------------------+
- the data folder is /mailu. Change this to a different value in case Mailu makes use of a different data folder.
| % | mailu | caching_sha2_password |
- All commands must be executed as root. On Debian/Ubuntu the sudo command is used to execute commands as root.
+-----------+-------+-----------------------+
Prepare the environment. Mailu must not be in use. Only the database container.
mysql> update mysql.user set plugin = 'mysql_native_password' where user = 'mailu';
mysql> SELECT host, user, plugin FROM mysql.user;
1. Open a terminal.
2. `cd /mailu`
+------+-------+-----------------------+
3. `docker-compose -p mailu down`
| host | user | plugin |
4. `docker-compose -p mailu up -d database`
+------+-------+-----------------------+
| % | mailu | mysql_native_password |
Create the dump SQL file for recreating the database.
The setup configuration wizard (setup.mailu.io) only supports creating config files for the same database back-end. When creating new config files, select PostgreSQL in the setup and enter dummy values for roundcube.
In the generated mailu.env file, remove all ROUNDCUBE_DB_* environment variables.
Now Admin will use PostgreSQL and roundcube will keep using Roundcube.
Roundcube does not offer a migration tool for moving from SQLite to PostgreSQL.
bors[bot]
3 years ago
committed by