Software / code / prosody-modules
Annotate
mod_block_outgoing/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 5007:34fb3d239ac1 |
| 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. |
|
5007
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
29 |
|
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
30 Compatibility |
|
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
31 ============= |
|
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
32 |
|
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
33 ------- -------------- |
|
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
34 trunk Doesn't work (uses is_admin) |
|
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
35 0.12 Works |
|
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
36 0.11 Works |
|
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
37 ------- -------------- |
|
34fb3d239ac1
*/README: Update compatibility info of modules still using legacy is_admin API
Matthew Wild <mwild1@gmail.com>
parents:
2400
diff
changeset
|
38 |
