Mercurial > prosody-modules
comparison mod_ogp/README.markdown @ 4460:205e50fdcebc
mod_ogp: Add README
| author | JC Brand <jc@opkode.com> |
|---|---|
| date | Mon, 22 Feb 2021 17:51:51 +0100 |
| parents | |
| children | c4f11a4b5ac7 |
comparison
equal
deleted
inserted
replaced
| 4459:dbfda7f5522d | 4460:205e50fdcebc |
|---|---|
| 1 # mod_ogp | |
| 2 | |
| 3 This module adds [Open Graph Protocol](https://ogp.me) metadata to URLs sent inside a MUC. | |
| 4 | |
| 5 With mod_ogp enabled, when a user sends a URL in a MUC (where the message has its `id` equal to its `origin-id`), the module calls the URL and parses the result for `<meta>` html tags that have any `og:...` properties. | |
| 6 If it finds any, it sends a [XEP-0422 fastening](https://xmpp.org/extensions/xep-0422.html) applied to the original message that looks like: | |
| 7 | |
| 8 ``` | |
| 9 <message id="example" from="chatroom@chatservice.example" to="chatroom@chatservice.example"> | |
| 10 <apply-to xmlns="urn:xmpp:fasten:0" id="origin-id-X"> | |
| 11 <meta xmlns="http://www.w3.org/1999/xhtml" property="og:title" content="The Rock"/> | |
| 12 <meta xmlns="http://www.w3.org/1999/xhtml" property="og:url" content="https://www.imdb.com/title/tt0117500/"/> | |
| 13 <meta xmlns="http://www.w3.org/1999/xhtml" property="og:image" content="https://ia.media-imdb.com/images/rock.jpg"/> | |
| 14 </apply-to> | |
| 15 </message> | |
| 16 ``` | |
| 17 | |
| 18 The module is intentionally simple in the sense that it is basically a transport for https://ogp.me/ |