Web server configuration settings
Configure the network environment in which Mattermost is deployed by going to System Console > Environment > Web Server, or by updating the config.json
file as described in the following table. Changes to configuration settings in this section require a server restart before taking effect.
Tip
Each configuration value below includes a JSON path to access the value programmatically in the config.json
file using a JSON-aware tool. For example, the SiteURL
value is under ServiceSettings
.
If using a tool such as jq, you’d enter:
cat config/config.json | jq '.ServiceSettings.SiteURL'
When working with the
config.json
file manually, look for the keyServiceSettings
, then within that object, find the keySiteURL
.
Site URL
Available in legacy Enterprise Edition E10/E20
The URL that users use to access Mattermost. The port number is required if it’s not a standard port, such as 80 or 443. This field is required. Select the Test Live URL button in the System Console to validate the Site URL. |
|
Notes:
|
Listen address
Available in legacy Enterprise Edition E10/E20
The address and port to which to bind and listen.
Specifying If you choose a port of a lower level (called “system ports” or “well-known ports”, in the range of 0-1023), you must have permissions to bind to that port. |
|
Forward port 80 to 443
Available in legacy Enterprise Edition E10/E20
Forward insecure traffic from port 80 to port 442.
|
|
Connection security
Available in legacy Enterprise Edition E10/E20
Connection security between Mattermost clients and the server.
|
|
TLS certificate file
Available in legacy Enterprise Edition E10/E20
The path to the certificate file to use for TLS connection security. String input |
|
TSL key file
Available in legacy Enterprise Edition E10/E20
The path to the TLS key file to use for TLS connection security. String input |
|
Use Let’s Encrypt
Available in legacy Enterprise Edition E10/E20
Enable the automatic retrieval of certificates from Let’s Encrypt. See the configuring TLS on Mattermost documentation for more details on setting up Let’s Encrypt.
|
|
Let’s Encrypt certificate cache file
Available in legacy Enterprise Edition E10/E20
The path to the file where certificates and other data about the Let’s Encrypt service will be stored. File path |
|
Read timeout
Available in legacy Enterprise Edition E10/E20
Maximum time allowed from when the connection is accepted to when the request body is fully read. Numerical input in seconds. Default is 300 seconds. |
|
Write timeout
Available in legacy Enterprise Edition E10/E20
allowed from the end of reading the request headers until the response is written. - If using HTTPS, it’s the total time from when the connection is accepted until the response is written. accepted to when the request body is fully read. Numerical input in seconds. Default is 300 seconds. |
|
Idle timeout
Available in legacy Enterprise Edition E10/E20
Set an explicit idle timeout in the HTTP server. This is the maximum time allowed before an idle connection is disconnected. Numerical input in seconds. Default is 300 seconds. |
|
Webserver mode
Available in legacy Enterprise Edition E10/E20
We recommend gzip to improve performance unless your environment has specific restrictions, such as a web proxy that distributes gzip files poorly.
|
|
Enable insecure outgoing connections
Available in legacy Enterprise Edition E10/E20
Security note: Enabling this feature makes these connections susceptible to man-in-the-middle attacks.
|
|
Managed resource paths
Available in legacy Enterprise Edition E10/E20
A comma-separated list of paths within the Mattermost domain that are managed by a third party service instead of Mattermost itself. Links to these paths will be opened in a new tab/window by Mattermost apps. For example, if Mattermost is running on
|
|
Note: When using the Mattermost Desktop App, additional configuration is required to open the link within the Desktop App instead of in a browser. See the desktop managed resources documentation for details. |
Reload configuration from disk
Available in legacy Enterprise Edition E10/E20
You must change the database line in the Select the Reload configuration from disk button in the System Console after changing your database configuration. Then, go to Environment > Database and select Recycle Database Connections to complete the reload. |
|
Purge all caches
Purge all in-memory caches for sessions, accounts, and channels by pressing Purge All Caches in the System Console. file, and then reload configuration to fail over without taking the server down. Select the Reload configuration from disk button in the System Console after changing your database configuration. Then, go to Environment > Database and select Recycle Database Connections to complete the reload. |
|
Note: Purging the caches may adversely impact performance. Deployments using High Availability will attempt to purge all the servers in the cluster. |