|
8 years ago | |
---|---|---|
bridge | 8 years ago | |
matterclient | 8 years ago | |
matterhook | 8 years ago | |
vendor | 8 years ago | |
Dockerfile | 8 years ago | |
LICENSE | 9 years ago | |
README.md | 8 years ago | |
matterbridge.conf.sample | 8 years ago | |
matterbridge.go | 8 years ago | |
migration.md | 8 years ago |
README.md
matterbridge
Simple bridge between mattermost and IRC.
- Relays public channel messages between mattermost and IRC.
- Supports multiple mattermost and irc channels.
- Matterbridge -plus also works with private groups on your mattermost.
This project has now matterbridge-plus merged in. Breaking changes for matterbridge can be found in migration
Requirements:
- [Mattermost] (https://github.com/mattermost/platform/) 3.x (stable, not a dev build)
Webhooks version
- Configured incoming/outgoing webhooks on your mattermost instance.
Plus (API) version
- A dedicated user(bot) on your mattermost instance.
binaries
Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/tag/v0.5.0)
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
- Copy the matterbridge.conf.sample to matterbridge.conf in the same directory as the matterbridge binary.
- Edit matterbridge.conf with the settings for your environment. See below for more config information.
- 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
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
webhooks version
You'll have to configure the incoming and 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 (192.168.1.1:9999 is the BindAddress specified in [mattermost] section of matterbridge.conf)
plus version
You'll have to create a new dedicated user on your mattermost instance. Specify the login and password in [mattermost] section of matterbridge.conf
FAQ
Please look at [matterbridge.conf.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.conf.sample) for more information first.
Mattermost doesn't show the IRC nicks
If you're running the webhooks version, this can be fixed by either:
- enabling "override usernames". See mattermost documentation
- setting
PrefixMessagesWithNick
totrue
inmattermost
section of your matterbridge.conf.
If you're running the plus version you'll need to:
- setting
PrefixMessagesWithNick
totrue
inmattermost
section of your matterbridge.conf.
Also look at the RemoteNickFormat
setting.