Store configuration in your database

Available on Entry, Professional, Enterprise, and Enterprise Advanced plans

If you have a self-hosted Mattermost deployment, you can use your database as the single source of truth for the active configuration of your Mattermost installation. This changes the Mattermost binary from reading the default config.json file to reading the configuration settings stored within a configuration table in the database. Mattermost has been running our community server on this option since the feature was released, and recommends its use for those on High Availability deployments.

Benefits to using this option:

• Conveniently manages configuration changes directly from the System Console, even in High Availability deployments and read-only containerized environments.
• Ensures all servers in a High Availability deployment have the same configuration, even when new servers are added to the cluster.
• Automatically deploys SAML certificates and keys to all servers in the cluster.

+Tip

The Mattermost configuration database and Mattermost application database are 2 different entities. It's possible to store Mattermost configuration in one database and Mattermost data in another database.

To do so, you must update the Datasource configuration setting to a new data source name, which can be done while the application is running. Explicitly setting the MM_SQLSETTINGS_DATASOURCE environment variable to override what has been defined in the configuration, whether it's in a database, or in a file, allows the correct data source name to be passed to the Mattermost application.

How to migrate configuration to the database

These instructions cover migrating the Mattermost configuration to your database and updating your systemd configuration to load it from the database.

!Important

• These instructions assume you have Mattermost server installed at /opt/mattermost. If you're running Mattermost in a different directory you'll have to modify the paths to match your environment.
• If you're running Mattermost in a High Availability cluster-based deployment, you must complete all of the steps below on each server in the cluster.

Get your database connection string

The first step is to get your master database connection string. We recommend accessing your config.json file to make a copy of the value in SqlSettings.DataSource, or your equivalent environment variable, MM_SQLSETTINGS_DATASOURCE.

!Important

• SqlSettings.DataSource must start with postgres:// or mysql://. If it doesn't, add it to the beginning based on the database in use. For example: postgres://mmuser:really_secure_password@localhost:5432/mattermost?sslmode=disable&connect_timeout=10
• If you see \u0026, replace it with &. For example: mysql://mmuser:really_secure_password@tcp(127.0.0.1:3306)/mattermost?charset=utf8mb4,utf8&writeTimeout=30s

Create an environment file

Create the file /opt/mattermost/config/mattermost.environment to set the MM_CONFIG environment variable to the database connection string. For example:

MM_CONFIG='postgres://mmuser:mostest_password@localhost:5432/mattermost_test?sslmode=disable&connect_timeout=10'

Run this command to verify the permissions on your Mattermost directory:

sudo chown -R mattermost:mattermost /opt/mattermost

Enable local mode

Edit the config.json to enable local mode by setting EnableLocalMode to true. See the local mode documentation for details on activating and using local mode.

Restart Mattermost

Run the following command to restart the Mattermost server and apply the configuration change:

sudo systemctl restart mattermost

Migrate configuration from config.json

You can use the mmctl config migrate command to migrate the configuration by running the following command:

./bin/mmctl config migrate path/to/config.json "postgres://mmuser:mostest_password@localhost:5432/mattermost_test?sslmode=disable&connect_timeout=10" --local

!Important

• If you're using a High Availability cluster-based deployment, you only need to run this command once and migrate the configuration from one server in the cluster.
• When migrating configuration, Mattermost incorporates configuration from any existing MM_* environment variables set in the current shell. See Environment Variables documentation for details.
• As with the environment file, you'll have to escape any single quotes in the database connection string.
• Any existing SAML certificates will be migrated into the database as well so they are available for all servers in the cluster. When the certificates expire, you can upload new certificates using the System Console or mmctl, which triggers a database update. Replacing the certificate files manually requires a reload of the Mattermost server to re-pull the certificates. Configuration files are stored in the configurationfiles table in the database.

When configuration in the database is enabled, any changes to the configuration are recorded to the Configurations and ConfigurationFiles tables. Furthermore, ClusterSettings.ReadOnlyConfig is ignored, enabling full use of the System Console.

If you have configuration settings that must be set on a per-server basis you should add them as environment variables to the mattermost.environment file. These must be on their own line, and you must escape them properly.

Modify the Mattermost systemd file

Find the mattermost.service file using the following command:

sudo systemctl status mattermost.service

The second line of output will have the location of the running mattermost.service.

      Loaded: loaded (/etc/systemd/system/mattermost.service; enabled; vendor preset: enabled)

Edit this file as root to add the below text just above the line that begins with ExecStart:

EnvironmentFile=/opt/mattermost/config/mattermost.environment

Here's a complete mattermost.service file with the EnvironmentFile line added:

[Unit]
Description=Mattermost
After=network.target
After=postgresql.service
Requires=postgresql.service

[Service]
Type=notify
EnvironmentFile=/opt/mattermost/config/mattermost.environment
ExecStart=/opt/mattermost/bin/mattermost
TimeoutStartSec=3600
KillMode=mixed
Restart=always
RestartSec=10
WorkingDirectory=/opt/mattermost
User=mattermost
Group=mattermost
LimitNOFILE=49152

[Install]
WantedBy=postgresql.service

Verify that the configuration was migrated correctly

Configurations are stored in the Configurations table in the database. Run the following query to verify that you've migrated the configuration successfully:

SELECT * FROM Configurations WHERE Active=true;

There should be exactly one line returned, and the Value field for that line should match your config.json file.

Reload systemd files and restart Mattermost

Run these commands to reload the daemon and restart Mattermost using the new MM_CONFIG environment variable.

sudo systemctl daemon-reload
sudo systemctl restart mattermost

!Important

Once you start using configuration in the database, you shouldn't manually edit the active configuration row. You should edit or update the configuration in one of the following ways:

• Use the System Console to make changes to the configuration.
• Use mmctl to make changes to the configuration.

The Mattermost server keeps active configuration in memory and writes new ones to the database only when there is a change. This way we avoid polling the database to process changes to the configuration. Publishing the changes to the cluster are handled by the application itself.

Rolling back

If you run into issues with your configuration in the database you can roll back to the config.json file by commenting out the MM_CONFIG line in /opt/mattermost/config/mattermost.environment and restarting Mattermost with systemctl restart mattermost.

Troubleshooting

Server fails to start

Providing the --disableconfigwatch flag while not actually pointing at a file will fail to start the server with an appropriate error message.