Differences between revisions 2 and 8 (spanning 6 versions)
Revision 2 as of 2021-03-18 21:06:33
Size: 2569
Editor: tmo-065-107
Comment: add message hiding code for another client, rcirc
Revision 8 as of 2022-04-11 21:43:55
Size: 2887
Editor: berlin01
Comment: Add lack of encryption as a known issue.
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:

{{{#!wiki caution
Note that as of [[https://github.com/matrix-org/purple-matrix/commit/a6522bb3986c332f7c3cbe3c4aa8e6945d6307ac|April 11, 2022]] purple-matrix is unmaintained and lacks [[https://github.com/matrix-org/purple-matrix/issues/18|support for end-to-end encryption]].
}}}
Line 21: Line 25:

=== OpenBSD package ===

A package is available in ports, however, make sure you have installed the bitlbee-libpurple flavor first. To install, enter in a terminal:

{{{
# pkg_add purple-matrix
}}}
Line 45: Line 57:
> account add matrix @<username>:<homeserver> <password> > account add matrix <user_id or user localpart> <password>
> account matrix set home_server <home_server>
Line 51: Line 64:
> account add matrix @username:matrix.org password > account add matrix @username:example.com password
> account matrix set home_server https://matrix.example.com/
Line 58: Line 72:
=== Spam in &bitlbee ===
''matrix - Connected'' messages being spammed in &bitlbee, does not seem to affect functionality. See Github issue [[https://github.com/matrix-org/purple-matrix/issues/31|#31]]
=== No support for encryption ===
Line 61: Line 74:
It's possible to hide the messages in most irc clients. No support for encrypted messages. '''Chat messages are always sent unencrypted. Incoming encrypted messages are silently dropped!''' See Github issue [[https://github.com/matrix-org/purple-matrix/issues/18|#18]].
Line 63: Line 76:
'''Irssi:'''
{{{
/ignore -regexp -pattern matrix.*Connected &bitlbee
}}}
=== Homeserver Port ===
If the homeserver you're connecting to requires a custom port, login will fail. See Github issue [[https://github.com/matrix-org/purple-matrix/issues/115|#115]]
Line 68: Line 79:
'''Weechat:'''
{{{
/filter add matrix_conn_msg *&bitlbee * matrix.*Connected
}}}

'''rcirc:'''
{{{
(defun my-rcirc-filter-bitlbee-matrix (orig-fun process sender response target text &optional activity)
  (unless
      (and target sender text
    (string= "&bitlbee" target)
    (string= sender "root")
    (string= text "matrix - Connected"))
    (apply orig-fun process sender response target text activity nil)))

(advice-add 'rcirc-print :around #'my-rcirc-filter-bitlbee-matrix)
}}}
Line 87: Line 81:

=== No SSO Support ===
See Github issue [[https://github.com/matrix-org/purple-matrix/issues/107|#107]]
(!!!)

How to set up Matrix with purple-matrix

Note that as of April 11, 2022 purple-matrix is unmaintained and lacks support for end-to-end encryption.

It is possible to communicate with matrix on bitlbee via libpurple and purple-matrix

Building and Installing

Ubuntu packages

Pre-built binaries are available for Ubuntu since version 17.04 (Zesty Zapus). You should be able to install them giving the following commands in a terminal window:

$ sudo apt update
$ sudo apt install purple-matrix

ArchLinux package

There package purple-matrix-git is available for Archlinux in AUR. The package works with bitlbee-libpurple-git and perhaps bitlbee-libpurple too.

OpenBSD package

A package is available in ports, however, make sure you have installed the bitlbee-libpurple flavor first. To install, enter in a terminal:

# pkg_add purple-matrix

Building from source

Building the plugin from source you will need development headers/libraries for the following:

  • libpurple 2.x [libpurple-dev] libjson-glib [libjson-glib-dev] libglib [libglib-dev (or libglib2.0-dev on Ubuntu 16.04 xenial)] libhttp_parser [libhttp-parser-dev].

You should then be able to:

$ git clone https://github.com/matrix-org/purple-matrix.git
$ cd purple-matrix
$ make
$ sudo make install

Usage

Add the account with:

> account add matrix <user_id or user localpart> <password>
> account matrix set home_server <home_server>
> account matrix on

Example:

> account add matrix @username:example.com password
> account matrix set home_server https://matrix.example.com/
> account matrix on

Known Issues

No support for encryption

No support for encrypted messages. Chat messages are always sent unencrypted. Incoming encrypted messages are silently dropped! See Github issue #18.

Homeserver Port

If the homeserver you're connecting to requires a custom port, login will fail. See Github issue #115

Human friendly chatroom names

chat names in matrix-purple are identified by ID in bitlbee and not with human friendly names, see GitHub issue #55

No SSO Support

See Github issue #107 (!!!)

BitlBee Wiki: HowtoMatrix (last edited 2022-04-11 21:43:55 by berlin01)