diff mod_discodot/README.markdown @ 4577:253df0798996

mod_discodot: Print a graph of service discovery
author Kim Alvefur <zash@zash.se>
date Thu, 27 May 2021 17:23:43 +0200 (2021-05-27)
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_discodot/README.markdown	Thu May 27 17:23:43 2021 +0200
@@ -0,0 +1,32 @@
+# 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`