Mercurial > prosody-modules

comparison mod_discodot/README.markdown @ 4577:253df0798996

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_discodot: Print a graph of service discovery
author Kim Alvefur <zash@zash.se>
date Thu, 27 May 2021 17:23:43 +0200
parents
children
comparison
equal deleted inserted replaced
4576:cade5dac1003 4577:253df0798996
1 # Flowcharts!
2
3 Put this module somewhere Prosody will find it and then run
4 `prosodyctl mod_discodot | dot -Tsvg -o disco-graph.svg` to receive a
5 graph like this[^1]:
6
7 +------------------------+ +------------------------------------------+
8 | proxy.external.example | <-- | VirtualHost "example.com" | -+
9 +------------------------+ +------------------------------------------+ |
10 | |
11 | |
12 v |
13 +------------------------------------------+ |
14 | Component "conference.example.com" "muc" | <+
15 +------------------------------------------+
16
17 Example config for the above:
18
19 ``` {.lua}
20 VirtualHost "xmpp.example.com"
21 disco_items = {
22 { "conference.example.com"; };
23 { "proxy.external.example"; };
24 }
25
26 Component "conference.example.com" "muc"
27 ```
28
29 Note the `disco_items` entry causing duplication since subdomains are
30 implicitly added.
31
32 [^1]: this was actuall made with `graph-easy`