jshiffer/matterbridge
1
0
Fork 1
mirror of https://github.com/42wim/matterbridge.git synced 2024-11-21 18:22:00 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocketchat, twitch, ssh-chat, zulip, whatsapp, keybase, matrix, microsoft teams, nextcloud, mumble, vk and more with REST API (mattermost not required!)
64 Commits 6 Branches 116 Tags 281 MiB
Go 99.4%
Dockerfile 0.5%
Shell 0.1%
3bc25f4707
Go to file
Wim 3bc25f4707 Update documentation
2016-07-12 00:25:32 +02:00
bridge Remove token check 2016-07-12 00:23:36 +02:00
matterclient Converge with matterbridge-plus 2016-07-11 21:23:33 +02:00
matterhook Add port to BindAddress 2016-07-11 23:22:56 +02:00
vendor Sync with mattermost 3.1.0 2016-06-23 20:28:05 +02:00
Dockerfile Add Dockerfile 2016-05-21 16:30:39 +02:00
LICENSE Initial commit 2015-10-23 17:07:05 +02:00
matterbridge.conf.sample Update documentation 2016-07-12 00:25:32 +02:00
matterbridge.go Converge with matterbridge-plus 2016-07-11 21:23:33 +02:00
README.md Update documentation 2016-07-12 00:25:32 +02:00

README.md

matterbridge

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

Requires mattermost 1.2.0+

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.

binaries

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

building

Go 1.6+ is required. 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.
Usage of ./matterbridge:
  -conf string
        config file (default "matterbridge.conf")
  -debug
        enable debug
  -plus
        running using API instead of webhooks
  -version
        show version

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. (use -conf to specify another file)

Look at [matterbridge.conf.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.conf.sample) for an example.

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)