summaryrefslogtreecommitdiffstats
path: root/README.md
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 /README.md
parentc1c7961dd6c32fa72b07010a74963edaa3ee113b (diff)
downloadmatterbridge-msglm-52fc94c1fe4f4615d776ce0c2a7e87c774e3cd53.tar.gz
matterbridge-msglm-52fc94c1fe4f4615d776ce0c2a7e87c774e3cd53.tar.bz2
matterbridge-msglm-52fc94c1fe4f4615d776ce0c2a7e87c774e3cd53.zip
Remove old files. Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 3 insertions, 18 deletions
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: