view mod_throttle_unsolicited/README.markdown @ 4974:807007913f67

mod_log_json: Prefer native Lua table.pack over Prosody util.table one Prosody is removing support for Lua 5.1, which was the reason for util.table.pack to exist in the first place, since Lua 5.2+ provides table.pack. In prosody rev 5eaf77114fdb everything was switched over to use table.pack, opening the door for removing util.table.pack at some point. This change here is to prepare for that future eventuality.
author Kim Alvefur <zash@zash.se>
date Mon, 11 Jul 2022 20:08:41 +0200
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
```