[GitHub] [james-project] chibenwa commented on a change in pull request #854: JAMES-3683 Document Rate limiting extension within Antora doc

[GitBox <gi...@apache.org>]

chibenwa commented on a change in pull request #854:
URL: https://github.com/apache/james-project/pull/854#discussion_r789361622



##########
File path: server/apps/distributed-app/docs/modules/ROOT/pages/extending/index.adoc
##########
@@ -129,3 +129,32 @@ public class MyMailet extends GenericMailet {
 ....
 
 Note that overriding injection definitions of the Distributed Server for your injections is not supported.
+
+== Pre-packaged extensions
+
+=== Rate Limiting for mailet processing
+
+*Vendor*: Apache Foundation (James project), Apache License V2
+
+link:https://github.com/apache/james-project/tree/master/server/mailet/rate-limiter[Project link] contains detailed set
+up instructions and configuration examples as well as a pre-configured docker-compose.
+
+This extension ships mailets for applying advanced rate limit criteria to the email transiting through your James server.
+It is shipped with two backends implemented:
+
+ - *in memory*: For single server mode.
+ - *Redis*: Uses link:https://redis.io/[Redis] as a shared, fast and scalable in-memory datastore, allowing to apply rate
+ limiting in a distributed fashion. Here is the link:https://github.com/apache/james-project/tree/master/server/mailet/rate-limiter[link] to the Redis extension for rate limiting.
+ - Alternative extensions can be written and loaded into James using the xref:extending/index.adoc#_handling_injections_for_your_extensions[Guice extension mechanism]

Review comment:
       The memory /redis choice demonstrates exactly this and I have an hyper link describing the process in loads of details!




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



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