2015-10-23 20:34:37 +00:00
# matterbridge
2015-10-23 20:39:03 +00:00
Simple bridge between mattermost and IRC. Uses the in/outgoing webhooks.
Relays public channel messages between mattermost and IRC.
2015-10-23 20:34:37 +00:00
2015-12-08 23:42:50 +00:00
Requires mattermost 1.2.0+
2015-10-23 20:34:37 +00:00
2015-10-23 21:02:14 +00:00
## binaries
2015-12-08 23:42:50 +00:00
Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/tag/v0.2)
2015-10-23 21:02:14 +00:00
2015-10-23 20:34:37 +00:00
## building
Make sure you have [Go ](https://golang.org/doc/install ) properly installed, including setting up your [GOPATH] (https://golang.org/doc/code.html#GOPATH)
```
cd $GOPATH
2015-10-30 08:57:23 +00:00
go get github.com/42wim/matterbridge
2015-10-23 20:34:37 +00:00
```
You should now have matterbridge binary in the bin directory:
```
$ ls bin/
matterbridge
```
## running
2015-10-23 20:39:03 +00:00
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.
2015-10-23 20:34:37 +00:00
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
2015-12-12 20:26:53 +00:00
#address the webserver will bind to
BindAddress="0.0.0.0"
2015-10-24 14:39:01 +00:00
showjoinpart=true #show irc users joining and parting
2015-10-24 16:01:15 +00:00
#the token you get from the outgoing webhook in mattermost. If empty no token check will be done.
token=yourtokenfrommattermost
2015-10-24 23:00:19 +00:00
#disable certificate checking (selfsigned certificates)
#SkipTLSVerify=true
2015-10-27 23:04:57 +00:00
[general]
#request your API key on https://github.com/giphy/GiphyAPI. This is a public beta key
GiphyApiKey="dc6zaTOxFJmzC"
2015-10-23 20:34:37 +00:00
```
### mattermost
You'll have to configure the incoming en outgoing webhooks.
* incoming webhooks
2015-10-23 20:39:03 +00:00
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)
2015-10-23 20:34:37 +00:00
* outgoing webhooks
2015-10-23 20:39:03 +00:00
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.
2015-10-23 20:34:37 +00:00
e.g. http://192.168.1.1:9999 (9999 is the port specified in [mattermost] section of matterbridge.conf)
