Mercurial > prosody-modules

annotate mod_drop_chatstates/README.md @ 6343:ee2ebdec1fae

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_s2s_cache_failures: New module to cache failures to remote domains and control retries
author Matthew Wild <mwild1@gmail.com>
date Thu, 16 Oct 2025 19:08:20 +0100
parents 92e2dcf039d9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6310
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
1 ---
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
2 labels:
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
3 - 'Stage-Alpha'
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
4 - 'Type-Web'
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
5 summary: Drop chatstates for specific domains.
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
6 rockspec:
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
7 build:
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
8 modules:
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
9 mod_drop_chatstates: mod_drop_chatstates.lua
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
10 ...
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
11
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
12 Introduction
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
13 ============
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
14
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
15 This is a Prosody module to drop chatstates for specific domains.
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
16
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
17 Clients that request chatstates to virtual JIDs (i.e. those created by
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
18 modules like mod\_voipms to send/receive SMS/MMS on domains like
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
19 'sms.example.com') will, by design, receive errors indicating the
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
20 service is unavailable. While most clients will silently ignore this,
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
21 clients like profanity will not. This module allows us to drop responses
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
22 for chatstates on selected domains if we know they will never respond.
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
23
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
24 Configuration
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
25 =============
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
26
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
27 | option | type | default | description
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
28 |---------------------------|--------|---------|-------------------------------|
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
29 | drop\_chatstates\_domains | table | {} | Domains to drop chatstates for
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
30
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
31 Sample module configuration:
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
32
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
33 ```
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
34 modules_enabled = {
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
35 "drop_chatstates";
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
36 }
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
37 drop_chatstates_domains = { "sms.example.com" }
92e2dcf039d9 mod_drop_chatstates: New module to drop chatstates for specific domains
Chaz Kettleson <chaz@pyr3x.com>
parents:
diff changeset
38 ```