GitHub/matterbridge
3
0
Fork 0
mirror of https://github.com/42wim/matterbridge.git synced 2024-11-25 13:39:34 +01:00
Code Issues Projects Releases Wiki Activity

Updated How to create your config (markdown)

Wim 2017-06-30 01:07:32 +02:00
parent 2dd01fd656
commit a1638dfebd
1 changed files with 61 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
How-to-create-your-config.md

@ -2,7 +2,9 @@
Create an empty matterbridge.toml file.
### Step 2
Choose the protocols you want to bridge below, and copy paste those into your config file.
Choose the protocols you want to bridge below, and copy paste those into your config file.
You can select as much different protocols as you like.
In the example we only use 2 protocols.
* [[Section-Discord-(basic)]]
* [[Section-Slack-(basic)]]
@ -16,7 +18,9 @@ Choose the protocols you want to bridge below, and copy paste those into your co
* [[Section-Steam-(basic)]]
* [[Section-Hipchat-(basic)]]
For example, you want to bridge discord and gitter.
In the example below we want messages from channel ```#general``` on discord to be sent to channel ```42wim/mygreatproject``` on gitter.
(and messages from channel ```42wim/mygreatproject``` on gitter to channel ```#general``` on discord
Just add below to the config
```
@ -36,7 +40,60 @@ RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
```
### Step 3
Change the Token and Server keys to actual working ones
Change the Token and Server keys above to actual working ones
### Step 4
Add the channel configuration to your confg file.
Add the gateway configuration to your config file.
Copy paste the config from [[Gateway-config-(basic)]]
### Step 5
Modify the gateway config matching the protocols you selected above.
For the correct ```channel=mychannel``` settings, look at [[Gateway-config-(channel-rules)]]
And save your matterbridge.toml file
```
[[gateway]]
name="gateway1"
enable=true
[[gateway.inout]]
account="discord.mydiscord"
channel="general"
[[gateway.inout]]
account="gitter.mygitter"
channel="42wim/mygreatproject"
```
### Step 6
Full configuration looks now like this:
```
[discord.mydiscord]
Token="MTk4NjIyNDgzNDcdOTI1MjQ4.Cl2FMZ.ZnCjm1XVW7vRze4b7Cq4se7kKWs-abD"
Server="myserver"
RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
[gitter.mygitter]
Token="319fda1761c6875739a489b6772daf2ace4b95d0"
RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
[[gateway]]
name="gateway1"
enable=true
[[gateway.inout]]
account="discord.mydiscord"
channel="general"
[[gateway.inout]]
account="gitter.mygitter"
channel="42wim/mygreatproject"
```
### Step 7
Run matterbridge
```
./matterbridge -conf matterbridge.toml
```