view mod_discodot/README.markdown @ 5245:e22cae58141d

mod_http_oauth2: Organize HTTP routes with comments Starting to get hard to follow. Usually one would start tracing the steps at the HTTP authorize route. Vaguely sorted alphabetically by path and point in the flow. (/register comes before /authorize tho)
author Kim Alvefur <zash@zash.se>
date Sun, 12 Mar 2023 11:27:29 +0100
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`