status-im
/
matterbridge
mirror of https://github.com/status-im/matterbridge.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocket.chat, steam, twitch, ssh-chat, zulip, whatsapp, keybase and matrix with REST API (mattermost not required!)
18 Commits 14 Branches 83 Tags 278 MiB
Go 98.3%
Solidity 1.2%
Dockerfile 0.4%
Shell 0.1%
Go to file
Wim 38fce68609 Fix go get path 2015-10-30 09:57:23 +01:00
matterhook Add DisableServer option 2015-10-28 17:19:32 +01:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
README.md Fix go get path 2015-10-30 09:57:23 +01:00
config.go Add giphy support. !gif <query> 2015-10-28 00:04:57 +01:00
matterbridge.conf.sample Add giphy support. !gif <query> 2015-10-28 00:04:57 +01:00
matterbridge.go Remove markdown for giphy 2015-10-28 00:16:42 +01:00

README.md

matterbridge

Simple bridge between mattermost and IRC. Uses the in/outgoing webhooks.
Relays public channel messages between mattermost and IRC.

Work in progress.

Requires mattermost build from master (or 1.2.0 when released).

binaries

Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/tag/v0.1)

building

Make sure you have Go properly installed, including setting up your [GOPATH] (https://golang.org/doc/code.html#GOPATH)

cd $GOPATH
go get github.com/42wim/matterbridge

You should now have matterbridge binary in the bin directory:

$ ls bin/
matterbridge

running

  1. Copy the matterbridge.conf.sample to matterbridge.conf in the same directory as the matterbridge binary.
  2. Edit matterbridge.conf with the settings for your environment. See below for more config information.
  3. Now you can run matterbridge.

Matterbridge will:

  • start a webserver listening on the port specified in the configuration.
  • connect to specified irc server and channel.
  • send messages from mattermost to irc and vice versa, messages in mattermost will appear with irc-nick

config

matterbridge

matterbridge looks for matterbridge.conf in current directory.

Look at matterbridge.conf.sample for an example

[IRC]
server="irc.freenode.net"
port=6667
UseTLS=false
SkipTLSVerify=true
nick="matterbot"
channel="#matterbridge"

[mattermost]
#url is your incoming webhook url (account settings - integrations - incoming webhooks)
url="http://mattermost.yourdomain.com/hooks/incomingwebhookkey"  
#port the bridge webserver will listen on
port=9999
showjoinpart=true #show irc users joining and parting
#the token you get from the outgoing webhook in mattermost. If empty no token check will be done.
token=yourtokenfrommattermost
#disable certificate checking (selfsigned certificates)
#SkipTLSVerify=true

[general]
#request your API key on https://github.com/giphy/GiphyAPI. This is a public beta key
GiphyApiKey="dc6zaTOxFJmzC"

mattermost

You'll have to configure the incoming en outgoing webhooks.

  • incoming webhooks Go to "account settings" - integrations - "incoming webhooks".
    Choose a channel at "Add a new incoming webhook", this will create a webhook URL right below.
    This URL should be set in the matterbridge.conf in the [mattermost] section (see above)

  • outgoing webhooks Go to "account settings" - integrations - "outgoing webhooks".
    Choose a channel (the same as the one from incoming webhooks) and fill in the address and port of the server matterbridge will run on.

e.g. http://192.168.1.1:9999 (9999 is the port specified in [mattermost] section of matterbridge.conf)