Software /
code /
prosody-modules
Annotate
mod_pubsub_github/README.markdown @ 3511:b583cce491de
mod_pubsub_github/README: Fix 'labels' metafield to be a list
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 31 Mar 2019 16:56:26 +0200 |
parent | 3264:f48bedd1d433 |
child | 3512:5fb14ae57b4c |
rev | line source |
---|---|
1803 | 1 --- |
3511
b583cce491de
mod_pubsub_github/README: Fix 'labels' metafield to be a list
Kim Alvefur <zash@zash.se>
parents:
3264
diff
changeset
|
2 labels: |
b583cce491de
mod_pubsub_github/README: Fix 'labels' metafield to be a list
Kim Alvefur <zash@zash.se>
parents:
3264
diff
changeset
|
3 - 'Stage-Beta' |
1803 | 4 summary: Publish Github commits over pubsub |
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
5 --- |
1803 | 6 |
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
7 ## Introduction |
1803 | 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 |
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
16 ## Configuration |
1803 | 17 |
18 Load the module on a pubsub component: | |
19 | |
20 Component "pubsub.example.com" "pubsub" | |
21 modules_enabled = { "pubsub_github" } | |
22 | |
23 The module also takes the following config options: | |
24 | |
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
25 Name Default Description |
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
26 ---------------- ----------- ------------------------------------------- |
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
27 github\_node "github" The pubsub node to publish commits on. |
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
28 github\_secret *not set* Shared secret used to sign HTTP requests. |
1803 | 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 | |
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
39 ## Compatibility |
1803 | 40 |
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
41 ------ ------------- |
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
42 0.10 Should work |
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
43 0.9 Works |
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
44 ------ ------------- |