matterbridge/README.md

117 lines
4.0 KiB
Markdown
Raw Normal View History

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-12-20 15:21:30 +00:00
There is also [matterbridge-plus] (https://github.com/42wim/matterbridge-plus) which uses the mattermost API and needs a dedicated user (bot). But requires no incoming/outgoing webhook setup.
2015-10-23 21:02:14 +00:00
## binaries
Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/tag/v0.4.1)
2015-10-23 21:02:14 +00:00
2015-10-23 20:34:37 +00:00
## building
2016-04-25 19:40:26 +00:00
Go 1.6+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed, including setting up your [GOPATH] (https://golang.org/doc/code.html#GOPATH)
2015-10-23 20:34:37 +00:00
```
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.
2015-12-19 15:55:49 +00:00
3) Now you can run matterbridge.
```
Usage of matterbridge:
-conf="matterbridge.conf": config file
```
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
2015-12-19 15:55:49 +00:00
matterbridge looks for matterbridge.conf in current directory. (use -conf to specify another file)
2015-10-23 20:34:37 +00:00
Look at matterbridge.conf.sample for an example
```
[IRC]
server="irc.freenode.net"
port=6667
UseTLS=false
SkipTLSVerify=true
nick="matterbot"
channel="#matterbridge"
UseSlackCircumfix=false
2016-06-16 19:01:46 +00:00
#Freenode nickserv
NickServNick="nickserv"
#Password for nickserv
NickServPassword="secret"
#Ignore the messages from these nicks. They will not be sent to mattermost
IgnoreNicks="ircspammer1 ircspammer2"
2015-10-23 20:34:37 +00:00
[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"
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.
2015-12-19 15:55:49 +00:00
#if you use multiple IRC channel (see below, this must be empty!)
2015-10-24 16:01:15 +00:00
token=yourtokenfrommattermost
#disable certificate checking (selfsigned certificates)
#SkipTLSVerify=true
#whether to prefix messages from IRC to mattermost with the sender's nick. Useful if username overrides for incoming webhooks isn't enabled on the mattermost server
PrefixMessagesWithNick=false
#how to format the list of IRC nicks when displayed in mattermost. Possible options are "table" and "plain"
NickFormatter=plain
#how many nicks to list per row for formatters that support this
NicksPerRow=4
#Ignore the messages from these nicks. They will not be sent to irc
IgnoreNicks="mmbot spammer2"
2015-10-27 23:04:57 +00:00
2015-12-19 15:55:49 +00:00
#multiple channel config
#token you can find in your outgoing webhook
[Token "outgoingwebhooktoken1"]
IRCChannel="#off-topic"
MMChannel="off-topic"
[Token "outgoingwebhooktoken2"]
IRCChannel="#testing"
MMChannel="testing"
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)