Mercurial > prosody-modules

annotate mod_block_outgoing/README.markdown @ 3496:262e68821f3f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_map: Experimental module exposing MAM summary
author Kim Alvefur <zash@zash.se>
date Mon, 25 Feb 2019 15:52:46 +0100
parents bd3a1df128a4
children 34fb3d239ac1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2400
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
1 ---
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
2 summary: 'Block outgoing stanzas from users'
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
3 ...
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
4
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
5 Introduction
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
6 ============
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
7
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
8 This module blocks all outgoing stanzas from a list of users.
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
9
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
10 Using
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
11 =====
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
12
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
13 Add mod_block_outgoing to the enabled modules in your config file:
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
14 ``` {.lua}
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
15 modules_enabled = {
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
16 -- ...
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
17 "block_outgoing",
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
18 -- ...
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
19 }
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
20 ```
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
21
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
22 Either in a section for a certain host or the global section define which users and what stanzas to block:
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
23 ``` {.lua}
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
24 block_outgoing_users = { "romeo@example.com", "juliet@example.com" }
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
25 block_outgoing_stanzas = { "message", "iq", "presence" }
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
26 ```
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
27
bd3a1df128a4 Add documentation for mod_block_outgoing
Michael Vetter <jubalh@openmailbox.org>
parents:
diff changeset
28 block_outgoing_stanzas defaults to "message" if not specified.