0 Section Matrix (basic)

Ben Wiederhake edited this page 2022-01-13 13:57:25 +01:00

Unescape Escape

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

⚠️ Create a dedicated user first. It will not relay messages from yourself if you use your account

[matrix.mymatrix]
#Server is your homeserver (eg https://matrix.org)
Server="https://matrix.org"

#login/pass of your bot.
#Use a dedicated user for this and not your own!
#Messages sent from this user will not be relayed to avoid loops.
Login="yourlogin"
Password="yourpass"

#Alternatively you can use MXID and access token (open https://app.element.io/
#in INCOGNITO mode, open Settings -> lowest tab and above "clear cache and reload"
#you can find the access token. Close the window without logging out
#(or the token gets invalid (if it leaks, it can be removed by logging in and using the sessions menu))
#MxID="@yourbot:example.net"
#Token="tokenforthebotuser"

RemoteNickFormat="[{PROTOCOL}] <{NICK}> "

#Whether to send the homeserver suffix. eg ":matrix.org" in @username:matrix.org
#to other bridges, or only send "username".(true only sends username)
#OPTIONAL (default false)
NoHomeServerSuffix=false

Example with pantalaimon

Matterbridge doesn’t properly encrypt its messages. So although matterbridge does work with matrix, even with matrix’ unencrypted rooms, the messages sent by matterbridge will all show a warning symbol to everyone, something about “WARNING: This message was sent unencrypted!”, which might irritate users.

So there is a need for something that sits in the middle, pretends to be a matrix server (so that matterbridge can talk to it), and can forward everything to the real matrix server (so that the messages actually arrive), and also magically transparently “encrypts” everything (so that the messages show no “unencrypted” warning). This is exactly what pantalaimon does. Keep in mind that this effectively means you do a MITM-attack on yourself, so the connection between matterbridge and pantalaimon is basically plaintext and very vulnerable. You really should run matterbridge and pantalaimon on the same machine, and make sure that pantalaimon is only accessible to yourself. (I don’t know if VPS is a problem here, so if you are running on a VPS then think twice before you do this setup.)

bridge.toml

[general]
MediaDownloadPath="/path/to/http/server/"
MediaServerDownload="https://foo.bar.org/server/"
MediaDownloadSize=10000000

[telegram.mytelegram]
Token="1234567890:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
RemoteNickFormat="{NICK}@{PROTOCOL}: "
MediaConvertWebPToPNG=true
MediaConvertTgs="png"
#QuoteFormat="{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE})"
UseFirstName=true

[matrix.mymatrix]
# Server="https://matrix.org"
# Matterbridge does not support encrypted group chats.
# Therefore, use Pantalaimon to MiTM myself:
Server="http://localhost:20662"
# Dedicated user
# Messages sent from this user will not be relayed to avoid loops.
Login="mybot"
Password="abcdefghijklmnopqrstuvwxyz"
RemoteNickFormat="{NICK}@{PROTOCOL}: "
#Whether to send the homeserver suffix. eg ":matrix.org" in @username:matrix.org
#to other bridges, or only send "username".(true only sends username)
NoHomeServerSuffix=true
HTMLDisable=true

[[gateway]]
name="foobar"
enable=true

[[gateway.inout]]
account="telegram.mytelegram"
channel="-1234567890123"

[[gateway.inout]]
account="matrix.mymatrix"
channel="!abcdefghijklmnopqr:matrix.org"

pantalaimon.conf

[Default]
LogLevel = Debug
SSL = True

[local-matrix]
Homeserver = https://matrix.org
ListenAddress = localhost
ListenPort = 20662
SSL = False
IgnoreVerification = True
UseKeyring = False

run_pantalaimon.sh

In theory, it suffices to just call dbus-run-session -- pantalaimon --config pantalaimon.conf

However, I want all the logs, so I run this:

dbus-run-session -- pantalaimon --log-level debug --config pantalaimon.conf 2>&1 | \
    ./tee_unless_regex.py 'INFO: pantalaimon: Trying to decrypt sync|INFO: pantalaimon: Decrypting sync' \
    2> pantalaimon_$(date +%s).log

tee_unless_regex.py

#!/usr/bin/env python3

import re
import sys

def run_regex(regex):
    while True:
        try:
            line = sys.stdin.readline()
        except KeyboardInterrupt:
            # Ctrl-C
            return
        if not line:
            # EOF
            return
        line = line.rstrip('\n')
        print(line)
        if not regex.search(line):
            print(line, file=sys.stderr)
            sys.stderr.flush()  # This flush() is the entire reason why I don't just use 'grep -v'. Somehow, unbuffer+grep just doesn't work. But why!?


def run():
    if len(sys.argv) != 2:
        print('USAGE: {} <SOME_REGEX>'.format(argv[0]))
        exit(1)

    run_regex(re.compile(sys.argv[1]))


if __name__ == '__main__':
    run()

Setup

There are setup-steps missing. In particular, you absolutely need pactl at some point. TODO: Please fill in these details.

Invocation

In one screen: ./run_pantalaimon.sh

In another screen: ./matterbridge-THEVERSION-linux-arm -conf bridge.toml -debug | tee bridge_$(date +%s).log

(Again, the -debug | … stuff isn’t necessary, but I personally want permanent logs of everything, just so I can trace back if something ever goes wrong. And I suggest that you do that, too.)

Home
Features
FAQ
Settings

Getting started
How to create your config
Discord bot setup
Slack bot setup
MS Teams setup

Deploy
DigitalOcean
Azure
Docker
Heroku

---

Gateways
Config: basic
Config: channel rules
Discord
Gitter
Hipchat
IRC
Keybase
Matrix
Mattermost
Microsoft Teams
Mumble
Nextcloud Talk
RocketChat
Slack
Sshchat
Steam
Telegram
Twitch
VK
WhatsApp
XMPP
Zulip

Advanced
Mediaserver setup
Service files

---

Developer
API
Tengo scripting
Making gateways