summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWim <wim@42.be>2017-07-22 17:50:34 +0200
committerWim <wim@42.be>2017-07-22 17:50:34 +0200
commit52fc94c1fe4f4615d776ce0c2a7e87c774e3cd53 (patch)
tree917cb3a97f4cb26dabad950afd2c56ca0752ea89
parentc1c7961dd6c32fa72b07010a74963edaa3ee113b (diff)
downloadmatterbridge-msglm-52fc94c1fe4f4615d776ce0c2a7e87c774e3cd53.tar.gz
matterbridge-msglm-52fc94c1fe4f4615d776ce0c2a7e87c774e3cd53.tar.bz2
matterbridge-msglm-52fc94c1fe4f4615d776ce0c2a7e87c774e3cd53.zip
Remove old files. Update readme
-rw-r--r--README-0.6.md115
-rw-r--r--README.md21
-rw-r--r--migration.md50
3 files changed, 3 insertions, 183 deletions
diff --git a/README-0.6.md b/README-0.6.md
deleted file mode 100644
index f25f4574..00000000
--- a/README-0.6.md
+++ /dev/null
@@ -1,115 +0,0 @@
-# matterbridge
-
-Simple bridge between mattermost, IRC, XMPP, Gitter and Slack
-
-* Relays public channel messages between mattermost, IRC, XMPP, Gitter and Slack. Pick and mix.
-* Supports multiple channels.
-* Matterbridge can also work with private groups on your mattermost.
-
-Look at [matterbridge.conf.sample] (https://github.com/42wim/matterbridge/blob/master/matterbridge.conf.sample) for documentation and an example.
-
-## Changelog
-Since v0.6.1 support for XMPP, Gitter and Slack is added. More details in [changelog.md] (https://github.com/42wim/matterbridge/blob/master/changelog.md)
-
-## Requirements:
-Accounts to one of the supported bridges
-* [Mattermost] (https://github.com/mattermost/platform/)
-* [IRC] (http://www.mirc.com/servers.html)
-* [XMPP] (https://jabber.org)
-* [Gitter] (https://gitter.im)
-* [Slack] (https://www.slack.com)
-
-## binaries
-Binaries can be found [here] (https://github.com/42wim/matterbridge/releases/)
-* For use with mattermost 3.3.0+ [v0.6.1](https://github.com/42wim/matterircd/releases/tag/v0.6.1)
-* For use with mattermost 3.0.0-3.2.0 [v0.5.0](https://github.com/42wim/matterircd/releases/tag/v0.5.0)
-
-
-## Docker
-Create your matterbridge.conf file locally eg in ```/tmp/matterbridge.conf```
-
-```
-docker run -ti -v /tmp/matterbridge.conf:/matterbridge.conf 42wim/matterbridge:0.6.1
-```
-
-## Compatibility
-### Mattermost
-* Matterbridge v0.6.1 works with mattermost 3.3.0 and higher [3.3.0 release](https://github.com/mattermost/platform/releases/tag/v3.3.0)
-* Matterbridge v0.5.0 works with mattermost 3.0.0 - 3.2.0 [3.2.0 release](https://github.com/mattermost/platform/releases/tag/v3.2.0)
-
-
-#### Webhooks version
-* Configured incoming/outgoing [webhooks](https://www.mattermost.org/webhooks/) on your mattermost instance.
-
-#### Plus (API) version
-* A dedicated user(bot) on your mattermost instance.
-
-
-## building
-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)
-
-```
-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 (deprecated, set Plus flag in [general] config)
- -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](http://docs.mattermost.com/developer/webhooks-incoming.html#enabling-incoming-webhooks)
-* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.conf.
-
-If you're running the plus version you'll need to:
-* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.conf.
-
-Also look at the ```RemoteNickFormat``` setting.
diff --git a/README.md b/README.md
index 3086f449..d4c2a12b 100644
--- a/README.md
+++ b/README.md
@@ -84,12 +84,12 @@ See [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config
[mattermost]
[mattermost.work]
- useAPI=true
Server="yourmattermostserver.tld"
Team="yourteam"
Login="yourlogin"
Password="yourpass"
PrefixMessagesWithNick=true
+ RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
[[gateway]]
name="mygateway"
@@ -107,7 +107,6 @@ enable=true
```
[slack]
[slack.test]
-useAPI=true
Token="yourslacktoken"
PrefixMessagesWithNick=true
@@ -133,11 +132,8 @@ RemoteNickFormat="[{PROTOCOL}/{BRIDGE}] <{NICK}> "
```
# Running
-1) Copy the matterbridge.toml.sample to matterbridge.toml
-2) Edit matterbridge.toml with the settings for your environment.
-3) Now you can run matterbridge. (```./matterbridge```)
-(Matterbridge will only look for the config file in your current directory, if it isn't there specify -conf "/path/toyour/matterbridge.toml")
+See [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration.
```
Usage of ./matterbridge:
@@ -162,18 +158,7 @@ See [changelog.md](https://github.com/42wim/matterbridge/blob/master/changelog.m
# FAQ
-Please look at [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.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](http://docs.mattermost.com/developer/webhooks-incoming.html#enabling-incoming-webhooks)
-* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml.
-
-If you're running the API version you'll need to:
-* setting ```PrefixMessagesWithNick``` to ```true``` in ```mattermost``` section of your matterbridge.toml.
-
-Also look at the ```RemoteNickFormat``` setting.
-
+See [FAQ](https://github.com/42wim/matterbridge/wiki/FAQ)
# Thanks
Matterbridge wouldn't exist without these libraries:
diff --git a/migration.md b/migration.md
deleted file mode 100644
index 3dc537c5..00000000
--- a/migration.md
+++ /dev/null
@@ -1,50 +0,0 @@
-# Breaking changes from 0.4 to 0.5 for matterbridge (webhooks version)
-## IRC section
-### Server
-Port removed, added to server
-```
-server="irc.freenode.net"
-port=6667
-```
-changed to
-```
-server="irc.freenode.net:6667"
-```
-### Channel
-Removed see Channels section below
-
-### UseSlackCircumfix=true
-Removed, can be done by using ```RemoteNickFormat="<{NICK}> "```
-
-## Mattermost section
-### BindAddress
-Port removed, added to BindAddress
-
-```
-BindAddress="0.0.0.0"
-port=9999
-```
-
-changed to
-
-```
-BindAddress="0.0.0.0:9999"
-```
-
-### Token
-Removed
-
-## Channels section
-```
-[Token "outgoingwebhooktoken1"]
-IRCChannel="#off-topic"
-MMChannel="off-topic"
-```
-
-changed to
-
-```
-[Channel "channelnameofchoice"]
-IRC="#off-topic"
-Mattermost="off-topic"
-```