view mod_pubsub_github/README.markdown @ 2407:be08b65f2855

mod_log_messages_sql: In 0.10ish, use 'messages' as default table name, override using 'log_messages_sql_table' if needed
author Matthew Wild <mwild1@gmail.com>
date Fri, 02 Dec 2016 19:06:37 +0000
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
  ----- -------