prosody-modules
4d73a1a6ba68
mod_pubsub_github/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_pubsub_github/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
child 3258:85e3117b2b60
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels: 'Stage-Beta'
3 summary: Publish Github commits over pubsub
4 ...
5
6 Introduction
7 ------------
8
9 This module accepts Github web hooks and publishes them to a local
10 pubsub component for XMPP clients to subscribe to.
11
12 Entries are pushed as Atom payloads.
13
14 Configuration
15 -------------
16
17 Load the module on a pubsub component:
18
19 Component "pubsub.example.com" "pubsub"
20 modules_enabled = { "pubsub_github" }
21
22 The module also takes the following config options:
23
24 Name Default Description
25 -------------- ---------- ----------------------------------------
26 github\_node "github" The pubsub node to publish commits on.
27
28 The URL for Github to post to would be either:
29
30 - http://pubsub.example.com:5280/pubsub\_github
31 - https://pubsub.example.com:5281/pubsub\_github
32
33 If your HTTP host doesn't match the pubsub component's address, you will
34 need to inform Prosody. For more info see Prosody's [HTTP server
35 documentation](https://prosody.im/doc/http#virtual_hosts).
36
37 Compatibility
38 -------------
39
40 ----- -------
41 0.9 Works
42 ----- -------