annotate mod_pubsub_github.wiki @ 476:6aa13786ce90

Created wiki page through web user interface.
author MWild1@gmail.com
date Tue, 19 Aug 2014 14:45:06 +0000
parents 3cd17a2dd5c6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
475
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
1 #summary Publish Github commits over pubsub
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
2 #labels Stage-Beta
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
3
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
4 = Introduction =
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
5
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
6 This module accepts Github web hooks and publishes them to a local pubsub component for XMPP clients to subscribe to.
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
7
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
8 Entries are pushed as Atom payloads.
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
9
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
10 = Configuration =
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
11
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
12 Load the module on a pubsub component:
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
13
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
14 {{{
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
15 Component "pubsub.example.com" "pubsub"
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
16 modules_enabled = { "pubsub_github" }
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
17 }}}
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
18
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
19 The module also takes the following config options:
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
20
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
21 || *Name* || *Default* || *Description* ||
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
22 || github_node || "github" || The pubsub node to publish commits on. ||
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
23
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
24 The URL for Github to post to would be either:
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
25
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
26 * http://pubsub.example.com:5280/pubsub_github
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
27 * https://pubsub.example.com:5281/pubsub_github
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
28
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
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].
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
30
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
31 = Compatibility =
3cd17a2dd5c6 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
32 || 0.9 || Works ||