annotate mod_bob/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 db75772afb28
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3342
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
1 ---
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
2 summary: Cache Bits of Binary on MUC services
4233
db75772afb28 mod_bob: Add dependency metadata
Kim Alvefur <zash@zash.se>
parents: 3342
diff changeset
3 rockspec:
db75772afb28 mod_bob: Add dependency metadata
Kim Alvefur <zash@zash.se>
parents: 3342
diff changeset
4 dependencies:
db75772afb28 mod_bob: Add dependency metadata
Kim Alvefur <zash@zash.se>
parents: 3342
diff changeset
5 - mod_cache_c2s_caps
3342
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
6 ---
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
7
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
8 Description
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
9 ===========
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
10
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
11 This module extracts cid: URIs (as defined in XEP-0231) from messages, and
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
12 replies with their content whenever another client asks for the actual data.
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
13
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
14 Usage
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
15 =====
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
16
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
17 ```lua
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
18 Component "rooms.example.org" "muc"
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
19 modules_enabled = {
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
20 "bob";
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
21 ...
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
22 }
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
23 ```