Differences between revisions 4 and 5
Revision 4 as of 2021-09-13 04:59:04
Size: 2224
Editor: 096-041-151-089
Comment: OpenBSD install info
Revision 5 as of 2022-04-08 13:24:18
Size: 2323
Editor: 8b23-fe46-e3ff-4a2a-53ff-42c0-07d0-2001
Comment: Improved the "Usage" section to also demonstrate setting the correct Matrix home server
Deletions are marked like this. Additions are marked like this.
Line 53: Line 53:
> account add matrix @<username>:<homeserver> <password> > account add matrix <identifier> <password>
> account matrix set home_server <home_server>
Line 59: Line 60:
> account add matrix @username:matrix.org password > account add matrix @username:example.com password
> account matrix set home_server https://matrix.example.com/

How to set up Matrix with purple-matrix

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 <identifier> <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

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)