view mod_discodot/README.markdown @ 4609:fcfe691d6322

mod_pubsub_summary: Use pre-escaped UTF-8 sequence for compat This silences a warning about using the non-existent global 'utf8' each time this line was hit. The utf8 library was introduced in Lua 5.3, so the warning would appear with 5.1 and 5.2.
author Kim Alvefur <zash@zash.se>
date Wed, 30 Jun 2021 15:53:49 +0200
parents 253df0798996
children
line wrap: on
line source

# Flowcharts!

Put this module somewhere Prosody will find it and then run
`prosodyctl mod_discodot | dot -Tsvg -o disco-graph.svg` to receive a
graph like this[^1]:

    +------------------------+     +------------------------------------------+
    | proxy.external.example | <-- |        VirtualHost "example.com"         | -+
    +------------------------+     +------------------------------------------+  |
                                     |                                           |
                                     |                                           |
                                     v                                           |
                                   +------------------------------------------+  |
                                   | Component "conference.example.com" "muc" | <+
                                   +------------------------------------------+

Example config for the above:

``` {.lua}
VirtualHost "xmpp.example.com"
disco_items = {
    { "conference.example.com"; };
    { "proxy.external.example"; };
}

Component "conference.example.com" "muc"
```

Note the `disco_items` entry causing duplication since subdomains are
implicitly added.

[^1]: this was actuall made with `graph-easy`