Mercurial > prosody-modules
annotate mod_pubsub_github/README.markdown @ 3503:882180b459a0
mod_pubsub_post: Restructure authentication and authorization (BC)
This deprecates the default "superuser" actor model and makes the
default equivalent to the previous "request.id".
A single actor and secret per node is supported because HTTP and
WebHooks don't normally include any authorization identity.
Allowing authentication bypass when no secret is given should be
relatively safe when the actor is unprivileged, as will be unless
explicitly configured otherwise.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sat, 30 Mar 2019 21:16:13 +0100 |
| parents | f48bedd1d433 |
| children | b583cce491de |
| rev | line source |
|---|---|
| 1803 | 1 --- |
| 2 labels: 'Stage-Beta' | |
| 3 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
|
4 --- |
| 1803 | 5 |
|
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
6 ## Introduction |
| 1803 | 7 |
| 8 This module accepts Github web hooks and publishes them to a local | |
| 9 pubsub component for XMPP clients to subscribe to. | |
| 10 | |
| 11 Entries are pushed as Atom payloads. | |
| 12 | |
|
3258
85e3117b2b60
mod_pubsub_github/README: Note that it might work with Gitlab as well
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
13 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
|
14 |
|
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
15 ## Configuration |
| 1803 | 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 | |
|
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
24 Name Default Description |
|
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
25 ---------------- ----------- ------------------------------------------- |
|
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
26 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
|
27 github\_secret *not set* Shared secret used to sign HTTP requests. |
| 1803 | 28 |
| 29 The URL for Github to post to would be either: | |
| 30 | |
| 31 - http://pubsub.example.com:5280/pubsub\_github | |
| 32 - https://pubsub.example.com:5281/pubsub\_github | |
| 33 | |
| 34 If your HTTP host doesn't match the pubsub component's address, you will | |
| 35 need to inform Prosody. For more info see Prosody's [HTTP server | |
| 36 documentation](https://prosody.im/doc/http#virtual_hosts). | |
| 37 | |
|
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
38 ## Compatibility |
| 1803 | 39 |
|
3264
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
40 ------ ------------- |
|
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
41 0.10 Should work |
|
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
42 0.9 Works |
|
f48bedd1d433
mod_pubsub_github: Add support for signed requests
Kim Alvefur <zash@zash.se>
parents:
3258
diff
changeset
|
43 ------ ------------- |