Configure file storage settings by going to System Console > Environment > File Storage, or by editing the config.json
file as described in the following tables.
Note
Mattermost currently supports storing files on the local filesystem and Amazon S3 or S3-compatible containers. We have tested Mattermost with MinIO and Digital Ocean Spaces products, but not all S3-compatible containers on the market. If you are looking to use other S3-compatible containers, we recommend completing your own testing.
File storage system#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The type of file storage system used. Can be either Local File System or Amazon S3.
|
|
Local storage directory#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The local directory to which files are written when the File storage system is set to local. Can be any directory writable by the user Mattermost is running as, and is relative to the directory where Mattermost is installed. Defaults to ./data/. |
|
Note: When File storage system is set to amazons3, this setting has no effect. |
Maximum file size#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The maximum file size for message attachments and plugin
uploads. This value must be specified in mebibytes in the
System Console, and in bytes in the The default is |
|
Warning: Verify server memory can support your setting choice. Large file sizes increase the risk of server crashes and failed uploads due to network disruptions. |
|
Notes:
|
Enable document search by content#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Enable users to search the contents of documents attached to messages.
|
|
Note: Document content search results for files shared before upgrading to Mattermost Server v5.35 may be incomplete until an extraction command is executed using the mmctl. If this command is not run, users can search older files based on file name only. You can optionally install the following dependencies to extend content searching support in Mattermost to include file formats beyond PDF, DOCX, and ODT, such as DOC, RTF, XML, and HTML:
If you choose not to install these dependencies, you’ll see log entries for documents that couldn’t be extracted. Any documents that can’t be extracted are skipped and logged so that content extraction can proceed. |
Enable searching content of documents within ZIP files#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Enables users to search the contents of compressed ZIP files attached to messages.
|
|
Note: Document content search within ZIP files is available, with mobile support coming soon. Searching document contents adds load to your server. For large deployments, or teams that share many large, text-heavy documents, we recommend you review our hardware requirements, and test enabling this feature in a staging environment before enabling it in a production environment. |
Amazon S3 bucket#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The name of the bucket for your S3-compatible object storage instance. A string with the S3-compatible bucket name. |
|
Amazon S3 path prefix#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The prefix you selected for your Amazon S3 bucket in AWS. A string containing the path prefix. |
|
Amazon S3 region#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The AWS region you selected when creating your Amazon S3 bucket in AWS. A string with the AWS region containing the bucket. If no region is set, Mattermost attempts to get the appropriate region from AWS, and sets it to us-east-1 if none found. |
|
Note: For MinIO or Digital Ocean Spaces, leave this setting empty. |
Amazon S3 access key ID#
Also available in legacy Mattermost Enterprise Edition E10 or E20
A string with the access key for the S3-compatible storage instance. Your EC2 administrator can supply you with the Access Key ID. |
|
Note: This is required for access unless you are using an Amazon S3 IAM Role with Amazon S3. |
Amazon S3 endpoint#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The hostname of your S3-compatible instance. A string with the hostname of the S3-compatible storage instance. Defaults to s3.amazonaws.com. |
|
Note: For Digital Ocean Spaces, the hostname should be set to <region>.digitaloceanspaces.com, where <region> is the abbreviation for the region you selected when setting up the Space. It can be nyc3, ams3, or sgp1. |
Amazon S3 secret access key#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The secret access key associated with your Amazon S3 Access Key ID. A string with the secret access key for the S3-compatible storage instance. |
|
Enable secure Amazon S3 connections#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Enable or disable secure Amazon S3 connections.
|
|
Amazon S3 signature v2#
Not available in legacy Mattermost Enterprise Edition E10 or E20
By default, Mattermost uses Signature v4 to sign API calls to AWS, but under some circumstances, v2 is required.
|
|
See the AWS documentation for information about when to use the Signature v2 signing process. |
Enable server-side encryption for Amazon S3#
Also available in legacy Mattermost Enterprise Edition E20
Enable server-side encryption for Amazon S3.
|
|
Enable Amazon S3 debugging#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Enable or disable Amazon S3 debugging to capture additional debugging information in system logs
|
|
Select the Test Connection button in the System Console to validate the settings and ensure the user can access the server. |
Amazon S3 request timeout#
The amount of time, in milliseconds, before requests to Amazon S3 storage time out. Default is 30000 (30 seconds). |
|
Amazon S3 upload part size#
The size, in bytes, of each part in a multi-part upload to Amazon S3. Numeric value. Default is 5242880 (5MB). |
|
Note: A smaller part size can result in more requests and an increase in latency, while a larger part size can result in more memory being allocated. |
Amazon S3 exported upload part size#
The size, in bytes, of each part in a multi-part exported to Amazon S3. Numeric value. Default is 104857600 (100MB). |
|
Note: A smaller part size can result in more requests and an increase in latency, while a larger part size can result in more memory being allocated. |
Initial font#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The font used in auto-generated profile pictures with colored backgrounds and username initials. A string with the font file name. Default is nunito-bold.ttf. |
|
Amazon S3 request timeout#
The amount of time, in milliseconds, before requests to Amazon S3 storage time out. Default is 30000 (30 seconds). |
|