prosody-modules: mod_pubsub_github/README.markdown@f48bedd1d433 (annotated)

1807 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	1	---
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	2	labels: 'Stage-Beta'
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	3	summary: Publish Github commits over pubsub
3268 f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	4	---
1807 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	5
3268 f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	6	## Introduction
1807 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	7
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	8	This module accepts Github web hooks and publishes them to a local
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	9	pubsub component for XMPP clients to subscribe to.
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	10
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	11	Entries are pushed as Atom payloads.
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	12
3262 85e3117b2b60 mod_pubsub_github/README: Note that it might work with Gitlab as well Kim Alvefur <zash@zash.se> parents: 1807 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: 1807 diff changeset	14
3268 f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	15	## Configuration
1807 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	16
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	17	Load the module on a pubsub component:
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	18
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	19	Component "pubsub.example.com" "pubsub"
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	20	modules_enabled = { "pubsub_github" }
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	21
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	22	The module also takes the following config options:
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	23
3268 f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	24	Name Default Description
f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	25	---------------- ----------- -------------------------------------------
f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 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: 3262 diff changeset	27	github\_secret not set Shared secret used to sign HTTP requests.
1807 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	28
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	29	The URL for Github to post to would be either:
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	30
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	31	- http://pubsub.example.com:5280/pubsub\_github
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	32	- https://pubsub.example.com:5281/pubsub\_github
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	33
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	34	If your HTTP host doesn't match the pubsub component's address, you will
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	35	need to inform Prosody. For more info see Prosody's [HTTP server
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	36	documentation](https://prosody.im/doc/http#virtual_hosts).
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	37
3268 f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	38	## Compatibility
1807 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	39
3268 f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	40	------ -------------
f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	41	0.10 Should work
f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	42	0.9 Works
f48bedd1d433 mod_pubsub_github: Add support for signed requests Kim Alvefur <zash@zash.se> parents: 3262 diff changeset	43	------ -------------

author	Kim Alvefur <zash@zash.se>
	Fri, 24 Aug 2018 17:49:53 +0200
changeset 3268	f48bedd1d433
parent 3262	85e3117b2b60
child 3515	b583cce491de
permissions	-rw-r--r--