Add sample documentation for hipchat support via xmpp

This commit is contained in:
Wim 2016-11-26 00:40:21 +01:00
parent 20c04f7977
commit e4ec27c5e2
3 changed files with 49 additions and 2 deletions

View File

@ -1,9 +1,9 @@
# matterbridge # matterbridge
![matterbridge.gif](https://s15.postimg.org/qpjhp6y3f/matterbridge.gif) ![matterbridge.gif](https://s15.postimg.org/qpjhp6y3f/matterbridge.gif)
Simple bridge between mattermost, IRC, XMPP, Gitter, Slack, Discord and Telegram. Simple bridge between mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram and Hipchat(via xmpp).
* Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack, Discord and Telegram. Pick and mix. * Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram and Hipchat (via xmpp). Pick and mix.
* Supports multiple channels. * Supports multiple channels.
* Matterbridge can also work with private groups on your mattermost. * Matterbridge can also work with private groups on your mattermost.
* Allow for bridging the same bridges, which means you can eg bridge between multiple mattermosts. * Allow for bridging the same bridges, which means you can eg bridge between multiple mattermosts.
@ -25,6 +25,7 @@ Accounts to one of the supported bridges
* [Slack] (https://slack.com) * [Slack] (https://slack.com)
* [Discord] (https://discordapp.com) * [Discord] (https://discordapp.com)
* [Telegram] (https://telegram.org) * [Telegram] (https://telegram.org)
* [Hipchat] (https://www.hipchat.com)
## Docker ## Docker
Create your matterbridge.toml file locally eg in ```/tmp/matterbridge.toml``` Create your matterbridge.toml file locally eg in ```/tmp/matterbridge.toml```

View File

@ -1,6 +1,7 @@
# v0.9.0-dev # v0.9.0-dev
## New features ## New features
* Telegram: New protocol support added (https://telegram.org) * Telegram: New protocol support added (https://telegram.org)
* Hipchat: Add sample config to connect to hipchat via xmpp
* Add support for dynamic Iconurl #43 * Add support for dynamic Iconurl #43
## General ## General

View File

@ -109,6 +109,50 @@ RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
#OPTIONAL (default false) #OPTIONAL (default false)
ShowJoinPart=false ShowJoinPart=false
###################################################################
#hipchat section
###################################################################
#Go to https://www.hipchat.com/account/xmpp this will show you the necessary data
#to fill in the section below
[xmpp.hipchat]
#xmpp server to connect to.
#REQUIRED
Server="chat.hipchat.com:5222"
#Jabber ID
#REQUIRED
Jid="12345_12345@chat.hipchat.com"
#Password (your hipchat password)
#REQUIRED
Password="yourpass"
#Conference (MUC) domain
#REQUIRED
Muc="conf.hipchat.com"
#Room nickname
#REQUIRED
Nick="yourlogin"
#Nicks you want to ignore.
#Messages from those users will not be sent to other bridges.
#OPTIONAL
IgnoreNicks="spammer1 spammer2"
#RemoteNickFormat defines how remote users appear on this bridge
#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.
#The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge
#The string "{PROTOCOL}" (case sensitive) will be replaced by the protocol used by the bridge
#OPTIONAL (default empty)
RemoteNickFormat="[{PROTOCOL}/{BRIDGE}] <{NICK}> "
#Enable to show users joins/parts from other bridges (only from irc-bridge at the moment)
#OPTIONAL (default false)
ShowJoinPart=false
################################################################### ###################################################################
#mattermost section #mattermost section
################################################################### ###################################################################
@ -425,6 +469,7 @@ enable=true
# - ID:123456789 (where 123456789 is the channel ID) # - ID:123456789 (where 123456789 is the channel ID)
# (https://github.com/42wim/matterbridge/issues/57) # (https://github.com/42wim/matterbridge/issues/57)
#telegram - chatid (a large negative number, eg -123456789) #telegram - chatid (a large negative number, eg -123456789)
#hipchat - id_channel (see https://www.hipchat.com/account/xmpp for the correct channel)
#REQUIRED #REQUIRED
channel="#testing" channel="#testing"