By default, ejabberd uses the Mnesia internal database. It is great for home and small office environments, but in larger companies, as the amount of chat logs and users grows, we need more scalability. Today, I will show you how to install MariaDB, a MySQL-compatible database, migrate your data and configure ejabberd to use MariaDB instead of Mnesia.
» Don’t want to migrate data yourself?
ProcessOne experts will make your communication scalable. Contact us »
We assume the usual Debian configuration as in my previous tutorials. I have updated my ejabberd to version 21.01 (the update process is the same as the initial ejabberd installation, so check my first tutorial).
To install MariaDB simply use:
apt-get install mariadb-server
Then run the installation wizard and follow the instructions:
Preparing MariaDB for ejabberd
To get MariaDB ready for ejabberd, we need to create a new database, its user, and then populate the database with the ejabberd SQL schema.
First, let’s create the database using your MariaDB
echo "CREATE DATABASE ejabberd;" | mysql -h localhost -u root -p
Next, let’s create a dedicated
ejabberd user authenticated with a
password, and assign it to this database. The
Enter password prompt is again asking about the
root MariaDB user:
echo "GRANT ALL ON ejabberd.* TO 'ejabberd'@'localhost' IDENTIFIED BY 'password';" | mysql -h localhost -u root -p
Finally, let’s download the latest ejabberd SQL schema and load it into our database. This time, we are switching to using the
ejabberd MariaDB user, and the
Enter password prompt is asking for the
password we just specified in the
GRANT command above:
wget https://raw.githubusercontent.com/processone/ejabberd/master/sql/mysql.sql mysql -h localhost -D ejabberd -u ejabberd -p < mysql.sql
To verify that everything is correct, run a command to display all the database tables, again using the
ejabberd MariaDB user, and the output should look something like that:
echo "SHOW TABLES;" | mysql -h localhost -D ejabberd -u ejabberd -p --table Enter password: +-------------------------+ | Tables_in_ejabberd | +-------------------------+ | archive | | archive_prefs | | bosh | | caps_features | | last | | mix_channel | | mix_pam | | mix_participant | | mix_subscription | | motd | | mqtt_pub | ...
Configuring ejabberd for MariaDB
Now that our MariaDB tables are ready, we need to configure ejabberd to use this MySQL-compatible database. Edit your
ejabberd.yml config and add the following settings, where
password refers to the
ejabberd MariaDB user:
sql_type: mysql sql_server: "localhost" sql_database: "ejabberd" sql_username: "ejabberd" sql_password: "password"
Migrating Mnesia data to MariaDB database
At this point, if you restart your ejabberd, it won’t be using MariaDB just yet. Let’s first migrate Mnesia data into our new SQL database using
ejabberdctl – we first export the data into a
mnesia.sql file, and then we import it into the MariaDB database:
cd /opt/ejabberd-21.01/bin/ ./ejabberdctl export2sql marekfoss.org /tmp/mnesia.sql mysql -h localhost -D ejabberd -u ejabberd -p < /tmp/mnesia.sql rm /tmp/mnesia.sql
It’s a good practice to remove the
/tmp/mnesia.sql after we are done with it. Now, add
default_db: sql to your
ejabberd.yml configuration file:
default_db: sql sql_type: mysql sql_server: "localhost" sql_database: "ejabberd" sql_username: "ejabberd" sql_password: "password"
Then, restart your ejabberd instance – it will now use the MariaDB database! Please note that the Mnesia database will still be started up and used for non-persistent data and clustering.
In this ejabberd tutorial series:
- How to move the office to ejabberd XMPP server
- How to set up ejabberd video & voice calling (STUN/TURN)
- How to configure ejabberd to get 100% in XMPP compliance test
- Check ejabberd XMPP server useful configuration steps
- Starting with MQTT protocol and ejabberd MQTT broker
- Getting started with WebSocket API in ejabberd
- Install and configure MariaDB with ejabberd
- Publish-Subscribe pattern and PubSub in ejabberd
Photo by Amy Asher on Unsplash