You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by bt...@apache.org on 2024/12/05 00:59:55 UTC

(james-project) 05/05: [DOCUMENTATION] Adoc for minio compatibility mode

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit 320af96002000172d7fa0c54d66da8420e1c143e
Author: Benoit TELLIER <bt...@linagora.com>
AuthorDate: Wed Dec 4 06:56:54 2024 +0100

    [DOCUMENTATION] Adoc for minio compatibility mode
---
 docs/modules/servers/partials/configure/blobstore.adoc | 14 ++++++++++++++
 docs/modules/servers/partials/configure/jvm.adoc       | 13 +++++++++++++
 2 files changed, 27 insertions(+)

diff --git a/docs/modules/servers/partials/configure/blobstore.adoc b/docs/modules/servers/partials/configure/blobstore.adoc
index e6cfb4c725..cec2a8a47e 100644
--- a/docs/modules/servers/partials/configure/blobstore.adoc
+++ b/docs/modules/servers/partials/configure/blobstore.adoc
@@ -146,6 +146,20 @@ Unless a special case like storing blobs of deleted messages.
 
 |===
 
+==== Improve listing support for MinIO
+
+Due to blobs being stored in folder, adding `/` in blobs name emulates folder and avoids blobs to be all stored in a
+same folder, thus improving listing.
+
+Instead of `1_628_36825033-d835-4490-9f5a-eef120b1e85c` the following blob id will be used: `1/628/3/6/8/2/5033-d835-4490-9f5a-eef120b1e85c`
+
+To enable blob hierarchy compatible with MinIO add in `jvm.properties`:
+
+----
+james.s3.minio.compatibility.mode=true
+----
+
+
 == Blob Export
 
 Blob Exporting is the mechanism to help James to export a blob from an user to another user.
diff --git a/docs/modules/servers/partials/configure/jvm.adoc b/docs/modules/servers/partials/configure/jvm.adoc
index 2d8fc35833..15011dc388 100644
--- a/docs/modules/servers/partials/configure/jvm.adoc
+++ b/docs/modules/servers/partials/configure/jvm.adoc
@@ -62,6 +62,19 @@ james.blob.id.hash.encoding=base16
 
 Optional. String. Defaults to base64Url.
 
+== Improve listing support for MinIO
+
+Due to blobs being stored in folder, adding `/` in blobs name emulates folder and avoids blobs to be all stored in a
+same folder, thus improving listing.
+
+Instead of `1_628_36825033-d835-4490-9f5a-eef120b1e85c` the following blob id will be used: `1/628/3/6/8/2/5033-d835-4490-9f5a-eef120b1e85c`
+
+To enable blob hierarchy compatible with MinIO add in `jvm.properties`:
+
+----
+james.s3.minio.compatibility.mode=true
+----
+
 == JMAP Quota draft compatibility
 
 Some JMAP clients depend on the JMAP Quota draft specifications. The property `james.jmap.quota.draft.compatibility` allows


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org