Skip to content

Commit 42570b8

Browse files
authored
Add rate limiting configuration to clustering settings
1 parent bdf0f47 commit 42570b8

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

source/deployment/cluster.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This documentation provides a deployment guide, configuration and compatibility
2020
- `Mattermost Server <https://docs.mattermost.com/deployment/cluster.html#mattermost-server-configuration>`_ - Configure the cluster settings for the Mattermost application server.
2121
- `Proxy Server <https://docs.mattermost.com/deployment/cluster.html#proxy-server-configuration>`_ - Configure NGINX or another load balancer to proxy servers in the cluster.
2222
- `File Storage Location <https://docs.mattermost.com/deployment/cluster.html#file-storage-configuration>`_ - Configure the file storage location to be compatible with a high availability setup.
23+
- `Rate Limiting <https://docs.mattermost.com/deployment/cluster.html#rate-limiting>`_ - Configure recommended rate limiting settings for a high availability setup.
2324
- `Database <https://docs.mattermost.com/deployment/cluster.html#database-configuration>`_ - Size and deploy a multi-database configuration for high availability and scaling.
2425

2526
- `Troubleshooting <https://docs.mattermost.com/deployment/cluster.html#id14>`_ - **Advice on troubleshooting your high availability setup.**
@@ -146,6 +147,19 @@ If you’re using the Compliance Reports feature in Enterprise Edition E20, you
146147

147148
Migrating to NAS or S3 from local storage is beyond the scope of this document.
148149

150+
Rate Limiting Configuration
151+
----------------------------------------
152+
153+
It is recommended to enable rate limiting with the following configuration settings:
154+
155+
- **Maximum Queries per Second**: 10
156+
- **Maximum Burst Size**: 100
157+
- **Memory Store Size**: Set to the number of users in the system
158+
- **Vary rate limit by remote address**: Set to ``true`` if you're using a proxy
159+
- **Vary rate limit by HTTP header**: Set to ``true`` if you're using a proxy
160+
161+
Please refer to our `Configuration Settings documentation <https://docs.mattermost.com/administration/config-settings.html#rate-limiting>`_ for more details on these settings.
162+
149163
Database Configuration
150164
------------------------------------
151165
Scaling the database can be accomplished by utilizing the read-replica feature. The Mattermost server can be set up to use one "master" database and up to 8 read replica databases. Mattermost distributes read requests across all databases, and sends write requests to the master database, and those changes are then sent to update the read replicas.

0 commit comments

Comments
 (0)