vttranlina commented on a change in pull request #870:
URL: https://github.com/apache/james-project/pull/870#discussion_r800377880
##########
File path: server/mailet/rate-limiter-redis/README.adoc
##########
@@ -0,0 +1,27 @@
+= Distributed Rate limiting for Apache James on top of Redis
+
+This package provides distributed rate limiting using Redis as a shared data
store.
+
+It reuses work of xref:../rate-limiter/README.adoc[the Rate Limiter
extensions] but substitute a Redis implementation
+for the underlying rate limiting.
+
+== Running rate limiting with the memory implementation
+
+- 1. Compile this project.
+- 2. Place the generated "jar with dependencies" in James `extensions-jars`
folder.
+- 3. Configure James to use the redis implementation for Rate Limiting by
putting the following content within
+`extension.properties`:
+
+----
+guice.extension.module=org.apache.james.rate.limiter.redis.R
Review comment:
```suggestion
guice.extension.module=org.apache.james.rate.limiter.redis.RedisRateLimiterModule
```
##########
File path: server/mailet/rate-limiter-redis/mailetcontainer.xml
##########
@@ -0,0 +1,171 @@
+<?xml version="1.0"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+ -->
+
+<!-- Read https://james.apache.org/server/config-mailetcontainer.html for
further details -->
+
+<mailetcontainer enableJmx="true">
+
+ <context>
+ <!-- When the domain part of the postmaster mailAddress is missing,
the default domain is appended.
+ You can configure it to (for example)
<postmaster>[email protected]</postmaster> -->
+ <postmaster>postmaster</postmaster>
+ </context>
+
+ <spooler>
+ <threads>20</threads>
+ <errorRepository>memory://var/mail/error/</errorRepository>
+ </spooler>
+
+ <processors>
+ <processor state="root" enableJmx="true">
+ <mailet match="All" class="PostmasterAlias"/>
+ <mailet match="RelayLimit=30" class="Null"/>
+ <mailet match="All" class="ToProcessor">
+ <processor>transport</processor>
+ </mailet>
+ </processor>
+
+ <processor state="error" enableJmx="true">
+ <mailet match="All" class="MetricsMailet">
+ <metricName>mailetContainerErrors</metricName>
+ </mailet>
+ <mailet match="All" class="Bounce">
+ <onMailetException>ignore</onMailetException>
+ </mailet>
+ <mailet match="All" class="ToRepository">
+ <repositoryPath>memory://var/mail/error/</repositoryPath>
+ <onMailetException>propagate</onMailetException>
+ </mailet>
+ </processor>
+
+ <processor state="transport" enableJmx="true">
+ <matcher name="relay-allowed"
match="org.apache.james.mailetcontainer.impl.matchers.Or">
+ <matcher match="SMTPAuthSuccessful"/>
+ <matcher match="SMTPIsAuthNetwork"/>
+ <matcher match="SentByMailet"/>
+ <matcher match="org.apache.james.jmap.mailet.SentByJmap"/>
+ </matcher>
+
+ <mailet match="All" class="RemoveMimeHeader">
+ <name>bcc</name>
+ <onMailetException>ignore</onMailetException>
+ </mailet>
+ <mailet match="All" class="RecipientRewriteTable">
+ <errorProcessor>rrt-error</errorProcessor>
+ </mailet>
+ <mailet match="RecipientIsLocal" class="ToProcessor">
+ <processor>local-delivery</processor>
+ </mailet>
+ <mailet match="HostIsLocal" class="ToProcessor">
+ <processor>local-address-error</processor>
+ <notice>550 - Requested action not taken: no such user
here</notice>
+ </mailet>
+ <mailet match="relay-allowed" class="ToProcessor">
+ <processor>relay</processor>
+ </mailet>
+ <mailet match="All" class="ToProcessor">
+ <processor>relay-denied</processor>
+ </mailet>
+ </processor>
+
+ <processor state="local-delivery" enableJmx="true">
+ <mailet match="All" class="VacationMailet">
+ <onMailetException>ignore</onMailetException>
+ </mailet>
+ <mailet match="All" class="Sieve">
+ <onMailetException>ignore</onMailetException>
+ </mailet>
+ <mailet match="All" class="AddDeliveredToHeader"/>
+ <mailet match="All"
class="org.apache.james.jmap.mailet.filter.JMAPFiltering">
+ <onMailetException>ignore</onMailetException>
+ </mailet>
+ <mailet match="All" class="LocalDelivery"/>
+ </processor>
+
+ <processor state="relay" enableJmx="true">
+ <mailet matcher="All" class="PerSenderRateLimit">
+ <redisURL>redis://redis:6379</redisURL>
Review comment:
if we use `redis.properties`, do we need to declare it here?
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
