Mercurial > prosody-modules
comparison mod_pubsub_github/README.wiki @ 1782:29f3d6b7ad16
Import wiki pages
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Mon, 24 Aug 2015 16:43:56 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 1781:12ac88940fe3 | 1782:29f3d6b7ad16 |
|---|---|
| 1 #summary Publish Github commits over pubsub | |
| 2 #labels Stage-Beta | |
| 3 | |
| 4 = Introduction = | |
| 5 | |
| 6 This module accepts Github web hooks and publishes them to a local pubsub component for XMPP clients to subscribe to. | |
| 7 | |
| 8 Entries are pushed as Atom payloads. | |
| 9 | |
| 10 = Configuration = | |
| 11 | |
| 12 Load the module on a pubsub component: | |
| 13 | |
| 14 {{{ | |
| 15 Component "pubsub.example.com" "pubsub" | |
| 16 modules_enabled = { "pubsub_github" } | |
| 17 }}} | |
| 18 | |
| 19 The module also takes the following config options: | |
| 20 | |
| 21 || *Name* || *Default* || *Description* || | |
| 22 || github_node || "github" || The pubsub node to publish commits on. || | |
| 23 | |
| 24 The URL for Github to post to would be either: | |
| 25 | |
| 26 * http://pubsub.example.com:5280/pubsub_github | |
| 27 * https://pubsub.example.com:5281/pubsub_github | |
| 28 | |
| 29 If your HTTP host doesn't match the pubsub component's address, you will need to inform Prosody. For more info see Prosody's [https://prosody.im/doc/http#virtual_hosts HTTP server documentation]. | |
| 30 | |
| 31 = Compatibility = | |
| 32 || 0.9 || Works || |