Software / code / prosody-modules
Diff
mod_pubsub_github/README.markdown @ 3264:f48bedd1d433
mod_pubsub_github: Add support for signed requests
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 24 Aug 2018 17:49:53 +0200 |
| parent | 3258:85e3117b2b60 |
| child | 3511:b583cce491de |
line wrap: on
line diff
--- a/mod_pubsub_github/README.markdown Fri Aug 24 17:46:47 2018 +0200 +++ b/mod_pubsub_github/README.markdown Fri Aug 24 17:49:53 2018 +0200 @@ -1,10 +1,9 @@ --- labels: 'Stage-Beta' summary: Publish Github commits over pubsub -... +--- -Introduction ------------- +## Introduction This module accepts Github web hooks and publishes them to a local pubsub component for XMPP clients to subscribe to. @@ -13,8 +12,7 @@ It may also work with Gitlab. -Configuration -------------- +## Configuration Load the module on a pubsub component: @@ -23,9 +21,10 @@ The module also takes the following config options: - Name Default Description - -------------- ---------- ---------------------------------------- - github\_node "github" The pubsub node to publish commits on. + Name Default Description + ---------------- ----------- ------------------------------------------- + github\_node "github" The pubsub node to publish commits on. + github\_secret *not set* Shared secret used to sign HTTP requests. The URL for Github to post to would be either: @@ -36,9 +35,9 @@ need to inform Prosody. For more info see Prosody's [HTTP server documentation](https://prosody.im/doc/http#virtual_hosts). -Compatibility -------------- +## Compatibility - ----- ------- - 0.9 Works - ----- ------- + ------ ------------- + 0.10 Should work + 0.9 Works + ------ -------------
