Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added notes & links connecting maxfilesize to common plugin upload error #6951

Merged
merged 1 commit into from
Mar 6, 2024
Merged

Added notes & links connecting maxfilesize to common plugin upload error #6951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions source/configure/file-storage-configuration-settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Local storage directory
:systemconsole: Environment > File Storage
:configjson: .FileSettings.MaxFileSize
:environment: MM_FILESETTINGS_MAXFILESIZE
:description: The maximum file size, in bytes, for message attachments. Default value is **104857600** bytes (1 megabyte).
:description: The maximum file size, in bytes, for message attachments and plugin uploads. Default value is **104857600** bytes (1 megabyte).

Maximum file size
~~~~~~~~~~~~~~~~~
Expand All @@ -80,19 +80,24 @@ Maximum file size
<p class="mm-label-note">Also available in legacy Mattermost Enterprise Edition E10 or E20</p>

+---------------------------------------------------------------+--------------------------------------------------------------------------+
| The maximum file size for message attachments. | - System Config path: **Environment > File Storage** |
| This value must be specified in megabytes in the | - ``config.json`` setting: ``".FileSettings.MaxFileSize: 104857600",`` |
| The maximum file size for message attachments and plugin | - System Config path: **Environment > File Storage** |
| uploads. This value must be specified in megabytes in the | - ``config.json`` setting: ``".FileSettings.MaxFileSize: 104857600",`` |
| System Console, and in bytes in the ``config.json`` file. | - Environment variable: ``MM_FILESETTINGS_MAXFILESIZE`` |
| | |
| The default is ``104857600`` bytes (**1** megabyte). | |
+---------------------------------------------------------------+--------------------------------------------------------------------------+
| **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. |
+---------------------------------------------------------------+--------------------------------------------------------------------------+
| **Note**: If you use a proxy or load balancer in front of Mattermost, the following proxy settings must be adjusted accordingly: |
| **Notes**: |
| |
| - For NGINX, use ``client_max_body_size``. |
| - For Apache use ``LimitRequestBody``. |
| - When `uploading plugin files </configure/plugins-configuration-settings.html#upload-plugin>`__, a ``Received invlaid response from |
| the server`` error typically indicates that ``MaxFileSize`` isn't large enough to support the plugin file upload, and/or that proxy |
| settings may not be sufficient. |
| - If you use a proxy or load balancer in front of Mattermost, the following proxy settings must be adjusted accordingly: |
| |
| - For NGINX, use ``client_max_body_size``. |
| - For Apache use ``LimitRequestBody``. |
+---------------------------------------------------------------+--------------------------------------------------------------------------+

.. config:setting:: file-enabledocsearchbycontent
Expand Down
11 changes: 7 additions & 4 deletions source/configure/plugins-configuration-settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Plugins configuration settings
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

Both self-hosted and Cloud admins can access the following configuration settings in **System Console > Plugins**. Self-hosted admins can also edit the ``config.json`` file as described in the following tables.
Self-hosted can manage the following configuration settings in **System Console > Plugins** or by editing the ``config.json`` file as described in the following tables.

- `Plugin Management <#plugin-management>`__
- `Apps <#apps>`__
Expand Down Expand Up @@ -78,7 +78,7 @@ Automatic prepackaged plugins
| | - Environment variable: ``MM_PLUGINSETTINGS_AUTOMATICPREPACKAGEDPLUGINS`` |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+

.. config:setting:: plugins-enableuploads
.. config:setting:: plugins-upload
:displayname: Upload Plugin (Plugins - Management)
:systemconsole: Plugins > Plugin Management
:configjson: EnableUploads
Expand All @@ -88,11 +88,14 @@ Upload Plugin
~~~~~~~~~~~~~

+------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| - **true**: Enables uploading of plugins from your local computer to your Mattermost server for all system admins. | - System Config path: **Plugins > Plugin Management** |
| - **true**: Enables you to upload plugins from your local computer to your Mattermost server for all system admins. | - System Config path: **Plugins > Plugin Management** |
| - **false**: **(Default)** Disables uploading of plugins from your local computer to your Mattermost server for all system admins. | - ``config.json`` setting: ``.PluginSettings.EnableUploads: false`` |
| | - Environment variable: ``MM_PLUGINSETTINGS_ENABLEUPLOADS`` |
+------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+

| **Note**: When plugin uploads are enabled, the error ``Received invlaid response from the server`` when uploading a plugin file typically indicates that the |
| `MaxFileSize </configure/environment-configuration-settings.html#maximum-file-size>`__ configuration setting isn't large enough to support the plugin file upload. |
| Additional proxy setting updateds may also be required. |
+------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+

.. config:setting:: plugins-enablemarketplace
:displayname: Enable marketplace (Plugins - Management)
Expand Down
Loading