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.

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

Add documentation for S3 storage classes #7467

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions source/configure/file-storage-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,44 @@ Amazon S3 exported upload part size
| **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. |
+---------------------------------------------------------------+--------------------------------------------------------------------------------------------+

.. config:setting:: file-amazons3storageclass
:displayname: Amazon S3 storage class (File Storage)
:systemconsole: N/A
:configjson: .FileSettings.AmazonS3StorageClass
:environment: MM_FILESETTINGS_AMAZONS3STORAGECLASS
:description: The storage class to use for uploads to S3 compatible storage solutions. Default value is an empty string.

Amazon S3 storage class
~~~~~~~~~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+---------------------------------------------------------------------+
| The storage class to use for uploads to S3 compatible | - System Config path: **Environment > File Storage** |
| storage solutions. | - ``config.json`` setting: ``".FileSettings.AmazonS3StorageClass"`` |
| | - Environment variable: ``MM_FILESETTINGS_AMAZONS3STORAGECLASS`` |
| String value. Default is an empty string. | |
+---------------------------------------------------------------+---------------------------------------------------------------------+
| **Note**: Most S3 compatible storage solutions assign a default storage class of ``STANDARD`` when no storage class is provided. |
+---------------------------------------------------------------+---------------------------------------------------------------------+

.. config:setting:: file-exportamazons3storageclass
:displayname: Export Amazon S3 storage class (File Storage)
:systemconsole: N/A
:configjson: .FileSettings.ExportAmazonS3StorageClass
:environment: MM_FILESETTINGS_EXPORTAMAZONS3STORAGECLASS
:description: The storage class to use for exports to S3 compatible storage solutions. Default value is an empty string.

Amazon S3 export storage class
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+---------------------------------------------------------------------------+
| The storage class to use for exports to S3 compatible | - System Config path: N/A |
| storage solutions. | - ``config.json`` setting: ``".FileSettings.ExportAmazonS3StorageClass"`` |
| | - Environment variable: ``MM_FILESETTINGS_EXPORTAMAZONS3STORAGECLASS`` |
| String value. Default is an empty string. | |
+---------------------------------------------------------------+---------------------------------------------------------------------------+
| **Note**: Most S3 compatible storage solutions assign a default storage class of ``STANDARD`` when no storage class is provided. |
+---------------------------------------------------------------+---------------------------------------------------------------------------+

.. config:setting:: file-initialfont
:displayname: Initial font (File Storage)
:systemconsole: N/A
Expand Down
Loading