Mercurial > prosody-modules
annotate mod_pubsub_github/README.markdown @ 3263:a65f4297264b
mod_pubsub_github: Unpack request from event
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 24 Aug 2018 17:46:47 +0200 |
| parents | 85e3117b2b60 |
| children | f48bedd1d433 |
| rev | line source |
|---|---|
| 1803 | 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 | |
|
3258
85e3117b2b60
mod_pubsub_github/README: Note that it might work with Gitlab as well
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
14 It may also work with Gitlab. |
|
85e3117b2b60
mod_pubsub_github/README: Note that it might work with Gitlab as well
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
15 |
| 1803 | 16 Configuration |
| 17 ------------- | |
| 18 | |
| 19 Load the module on a pubsub component: | |
| 20 | |
| 21 Component "pubsub.example.com" "pubsub" | |
| 22 modules_enabled = { "pubsub_github" } | |
| 23 | |
| 24 The module also takes the following config options: | |
| 25 | |
| 26 Name Default Description | |
| 27 -------------- ---------- ---------------------------------------- | |
| 28 github\_node "github" The pubsub node to publish commits on. | |
| 29 | |
| 30 The URL for Github to post to would be either: | |
| 31 | |
| 32 - http://pubsub.example.com:5280/pubsub\_github | |
| 33 - https://pubsub.example.com:5281/pubsub\_github | |
| 34 | |
| 35 If your HTTP host doesn't match the pubsub component's address, you will | |
| 36 need to inform Prosody. For more info see Prosody's [HTTP server | |
| 37 documentation](https://prosody.im/doc/http#virtual_hosts). | |
| 38 | |
| 39 Compatibility | |
| 40 ------------- | |
| 41 | |
| 42 ----- ------- | |
| 43 0.9 Works | |
| 44 ----- ------- |