changeset 2400:bd3a1df128a4

Add documentation for mod_block_outgoing
author Michael Vetter <jubalh@openmailbox.org>
date Sat, 26 Nov 2016 00:34:05 +0100
parents 913bd81a4d3c
children 7a1625a84624
files mod_block_outgoing/README.markdown
diffstat 1 files changed, 28 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_block_outgoing/README.markdown	Sat Nov 26 00:34:05 2016 +0100
@@ -0,0 +1,28 @@
+---
+summary: 'Block outgoing stanzas from users'
+...
+
+Introduction
+============
+
+This module blocks all outgoing stanzas from a list of users.
+
+Using
+=====
+
+Add mod_block_outgoing to the enabled modules in your config file:
+``` {.lua}
+modules_enabled = {
+	-- ...
+		"block_outgoing",
+	-- ...
+}
+```
+
+Either in a section for a certain host or the global section define which users and what stanzas to block:
+``` {.lua}
+block_outgoing_users = { "romeo@example.com", "juliet@example.com" }
+block_outgoing_stanzas = { "message", "iq", "presence" }
+```
+
+block_outgoing_stanzas defaults to "message" if not specified.