Mercurial > prosody-modules

comparison mod_pubsub_github/README.markdown @ 3264:f48bedd1d433

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_pubsub_github: Add support for signed requests
author Kim Alvefur <zash@zash.se>
date Fri, 24 Aug 2018 17:49:53 +0200
parents 85e3117b2b60
children b583cce491de
comparison
equal deleted inserted replaced
3263:a65f4297264b 3264:f48bedd1d433
1 --- 1 ---
2 labels: 'Stage-Beta' 2 labels: 'Stage-Beta'
3 summary: Publish Github commits over pubsub 3 summary: Publish Github commits over pubsub
4 ... 4 ---
5 5
6 Introduction 6 ## Introduction
7 ------------
8 7
9 This module accepts Github web hooks and publishes them to a local 8 This module accepts Github web hooks and publishes them to a local
10 pubsub component for XMPP clients to subscribe to. 9 pubsub component for XMPP clients to subscribe to.
11 10
12 Entries are pushed as Atom payloads. 11 Entries are pushed as Atom payloads.
13 12
14 It may also work with Gitlab. 13 It may also work with Gitlab.
15 14
16 Configuration 15 ## Configuration
17 -------------
18 16
19 Load the module on a pubsub component: 17 Load the module on a pubsub component:
20 18
21 Component "pubsub.example.com" "pubsub" 19 Component "pubsub.example.com" "pubsub"
22 modules_enabled = { "pubsub_github" } 20 modules_enabled = { "pubsub_github" }
23 21
24 The module also takes the following config options: 22 The module also takes the following config options:
25 23
26 Name Default Description 24 Name Default Description
27 -------------- ---------- ---------------------------------------- 25 ---------------- ----------- -------------------------------------------
28 github\_node "github" The pubsub node to publish commits on. 26 github\_node "github" The pubsub node to publish commits on.
27 github\_secret *not set* Shared secret used to sign HTTP requests.
29 28
30 The URL for Github to post to would be either: 29 The URL for Github to post to would be either:
31 30
32 - http://pubsub.example.com:5280/pubsub\_github 31 - http://pubsub.example.com:5280/pubsub\_github
33 - https://pubsub.example.com:5281/pubsub\_github 32 - https://pubsub.example.com:5281/pubsub\_github
34 33
35 If your HTTP host doesn't match the pubsub component's address, you will 34 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 35 need to inform Prosody. For more info see Prosody's [HTTP server
37 documentation](https://prosody.im/doc/http#virtual_hosts). 36 documentation](https://prosody.im/doc/http#virtual_hosts).
38 37
39 Compatibility 38 ## Compatibility
40 -------------
41 39
42 ----- ------- 40 ------ -------------
43 0.9 Works 41 0.10 Should work
44 ----- ------- 42 0.9 Works
43 ------ -------------