view mod_throttle_unsolicited/README.markdown @ 5141:027fb71ad509

Remove reverse dependencies on mod_invites (for plugin installer) Since mod_invites is included with Prosody 0.12, the same version which includes the plugin installer, there should be no need to depend on in.
author Kim Alvefur <zash@zash.se>
date Tue, 10 Jan 2023 20:49:17 +0100
parents 476afcbfb3e9
children
line wrap: on
line source

---
rockspec:
  dependencies:
  - mod_track_muc_joins
summary: Limit rate of outgoing unsolicited messages
---

Introduction
============

This module limits the rate of outgoing unsolicited messages from local
clients. Optionally, unsolicited messages coming in from remote servers
may be limited per s2s conneciton. A message counts as "unsolicited" if
the receiving user hasn't added the sending user to their roster.

The module depends on [mod\_track\_muc\_joins] in order to allow sent
messages to joined MUC rooms.

Configuration
=============

To set a limit on messages from local sessions:

``` {.lua}
unsolicited_messages_per_minute = 10
```

To enable limits on unsolicited messages from s2s connections:

``` {.lua}
unsolicited_s2s_messages_per_minute = 100
```