You can configure Mattermost as a high availability cluster-based deployment by going to System Console > Environment > High Availability, or by editing the config.json
file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect.
In a Mattermost high availability cluster-based deployment, the System Console is set to read-only, and settings can only be changed by editing the config.json
file directly. However, to test a high availability cluster-based environment, you can disable ClusterSettings.ReadOnlyConfig
in the config.json
file by setting it to false
. This allows changes applied using the System Console to be saved back to the configuration file.
Enable high availability mode#
Also available in legacy Mattermost Enterprise Edition E20
You can enable high availability mode.
|
|
Cluster name#
Also available in legacy Mattermost Enterprise Edition E20
The cluster to join by name in a high availability cluster-based deployment. Only nodes with the same cluster name will join together. This is to support blue-green deployments or staging pointing to the same database. |
|
Override hostname#
Also available in legacy Mattermost Enterprise Edition E20
You can override the hostname of this server.
|
|
See the high availability cluster-based deployment documentation for details. |
Use IP address#
Also available in legacy Mattermost Enterprise Edition E20
You can configure your high availability cluster-based deployment to communicate using the hostname instead of the IP address.
|
|
Enable experimental gossip encryption#
Also available in legacy Mattermost Enterprise Edition E20
Gossip encryption uses AES-256 by default, and this value isn’t configurable by design.
|
|
Note: Alternatively, you can manually set the |
Enable gossip compression#
Also available in legacy Mattermost Enterprise Edition E20
We recommend that you disable this configuration setting for better performance.
|
|
Gossip port#
Also available in legacy Mattermost Enterprise Edition E20
The port used for the gossip protocol. Both UDP and TCP should be allowed on this port. Numerical input. Default is 8074. |
|
Read only config#
Also available in legacy Mattermost Enterprise Edition E20
|
|
Network interface#
Also available in legacy Mattermost Enterprise Edition E20
An IP address used to identify the device that does automatic IP detection in high availability cluster-based deployments. String input. |
|
Bind address#
Also available in legacy Mattermost Enterprise Edition E20
An IP address used to bind cluster traffic to a specific network device. This setting is used primarily for servers with multiple network devices or different Bind Address and Advertise Address like in deployments that involve NAT (Network Address Translation). String input. |
|
Advertise address#
Also available in legacy Mattermost Enterprise Edition E20
The IP address used to access the server from other nodes. This settings is used primary when cluster nodes are not in the same network and involve NAT (Network Address Translation). String input. |
|