changeset 2390:28fbe960adcf

mod_firewall: README: Document conditions for groups and admins
author Matthew Wild <mwild1@gmail.com>
date Sat, 19 Nov 2016 16:08:58 +0000
parents a753b21968c5
children 85d04dd87f14
files mod_firewall/README.markdown
diffstat 1 files changed, 19 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mod_firewall/README.markdown	Sat Nov 19 16:01:51 2016 +0000
+++ b/mod_firewall/README.markdown	Sat Nov 19 16:08:58 2016 +0000
@@ -234,6 +234,25 @@
 
     IN_ROSTER_GROUP: Friends
 
+### Groups
+
+Using Prosody's mod\_groups it is possible to define groups of users on the server. You can
+match based on these groups in firewall rules.
+
+  Condition     Matches
+  ------------- ----------------------------
+  `FROM_GROUP`  When the stanza is being sent from a member of the named group
+  `TO_GROUP`    When the stanza is being sent to a member of the named group
+
+### Admins
+
+Prosody allows certain JIDs to be declared as administrators of a host, component or the whole server.
+
+  Condition      Matches
+  -------------- ----------------------------------
+  FROM_ADMIN_OF  When the sender of the stanza is an admin of the named host on the current server
+  TO_ADMIN_OF    When the recipient of the stanza is an admin of the named host on the current server
+
 ### Time and date
 
 #### TIME