[doc] Add about uploading objects which related to /issues/1017

leo-project · Mar 29, 2018 · 3146d89 · 3146d89
1 parent e01d763
commit 3146d89
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/admin/settings/leo_gateway.md b/docs/admin/settings/leo_gateway.md
@@ -108,6 +108,21 @@ If you want to customize settings like where to place `leo_gateway.conf`, what u
 | `process_limit`                           | The maxinum number of Erlang processes. Sets the maximum number of simultaneously existing processes for this system if a Number is passed as value. Valid range for Number is [1024-134217727]<p>*( Default: 1048576 )*</p> |
 
 ### Notes and Tips of the Configuration
+#### Uploading Objects
+
+LeoFS has two options for uploading objects:
+
+##### Upload objects in a single operation
+
+You can upload objects **up to 5 GB** in size with a single PUT operation. If you would like to change the limit, you need to modify one of the following settings or both of your LeoGateway's configuration, `leo_gateway.conf`:
+
+* `large_object.max_chunked_objs` *(default: 1000)*
+* `large_object.chunked_obj_len` *(default: 5242880, Unit: `byte`)*
+
+##### Upload objects in parts
+
+You can upload large objects with using the multipart upload S3-API. You can upload objects in parts. The upper limit of one part is **2 GB**.
+
 
 #### Cache Consistency between LeoGateway and LeoStorage
 

diff --git a/docs/faq/client.md b/docs/faq/client.md
@@ -12,3 +12,8 @@
 * Related Links:
     * [A Comment on LeoFS' Issue #748, Connecting to bucket causes badarg error](https://github.com/leo-project/leofs/issues/748#issuecomment-306391378)
     * [For Administrators / System Operations / S3 / Endpoint](../admin/system_operations/s3.md#endpoint)
+
+
+## Uploading Objects
+
+See [Administrators / Settings / LeoGateway Settings - Uploading Objects](/admin/settings/leo_gateway.md)