view mod_pubsub_github/README.markdown @ 3139:03cda95ae97a

mod_pastebin: Prevent header table form being mutated default_headers was mutated, probably by mod_http_errors and ended up with multiple content-type entries, which led to issues in browsers which would sometimes treat the paste as html
author Kim Alvefur <zash@zash.se>
date Sat, 23 Jun 2018 16:37:15 +0200
parents 4d73a1a6ba68
children 85e3117b2b60
line wrap: on
line source

---
labels: 'Stage-Beta'
summary: Publish Github commits over pubsub
...

Introduction
------------

This module accepts Github web hooks and publishes them to a local
pubsub component for XMPP clients to subscribe to.

Entries are pushed as Atom payloads.

Configuration
-------------

Load the module on a pubsub component:

    Component "pubsub.example.com" "pubsub"
        modules_enabled = { "pubsub_github" }

The module also takes the following config options:

  Name           Default    Description
  -------------- ---------- ----------------------------------------
  github\_node   "github"   The pubsub node to publish commits on.

The URL for Github to post to would be either:

-   http://pubsub.example.com:5280/pubsub\_github
-   https://pubsub.example.com:5281/pubsub\_github

If your HTTP host doesn't match the pubsub component's address, you will
need to inform Prosody. For more info see Prosody's [HTTP server
documentation](https://prosody.im/doc/http#virtual_hosts).

Compatibility
-------------

  ----- -------
  0.9   Works
  ----- -------