Pantalaimon: Difference between revisions

From Alpine Linux
(quickstart)
 
m (AFAIK Fractal supports encryption now, making the reference to it irrelevant. Also corrected grammar.)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''[https://github.com/matrix-org/pantalaimon/tree/master/ Pantalaimon]''' is a [https://matrix.org Matrix] proxy that handles end-to-end encryption support.
'''[https://github.com/matrix-org/pantalaimon/tree/master/ Pantalaimon]''' is a [https://matrix.org Matrix] proxy that handles end-to-end encryption support.


Installation
== Installation ==
============


It can be installed with the {{Pkg|pantalaimon}} package, and the <code>panctl</code> command line tool is in the {{Pkg|pantalaimon-ui}} package.
It can be installed with the {{Pkg|pantalaimon}} package, and the <code>panctl</code> command line tool is in the {{Pkg|pantalaimon-ui}} package.


Quickstart
== Quickstart ==
==========


There is two ways pantalaimon can be used: the first is to allow a bot access to an encryted room, and the second is allowing a human to use access an encrypted room with a client that doesn't support end to end encryption yet, like [https://www.matrix.org/docs/projects/client/fractal.html Fractal]. This wiki page currently only cover the second use case.
There are two ways pantalaimon can be used: the first is to allow a bot access to an encrypted room, and the second is allowing a human to use access an encrypted room with a client that doesn't support end to end encryption yet. This wiki page currently only cover the second use case.


First, create a config file for pantalaimon at <code>~/.config/pantalaimon/pantalaimon.conf</code>:
First, create a config file for pantalaimon at {{path|~/.config/pantalaimon/pantalaimon.conf}}:


  [MyMatrixServer]
  [MyMatrixServer]
  Homeserver = https://matrix.myserver.xyz
  Homeserver = <nowiki>https://matrix.myserver.xyz</nowiki>
  ListenAddress = localhost
  ListenAddress = localhost
  ListenPort = 8009
  ListenPort = 8009
Line 22: Line 20:
Then launch <code>pantalaimon</code> as your user. You can then control it through dbus using <code>panctl</code>.
Then launch <code>pantalaimon</code> as your user. You can then control it through dbus using <code>panctl</code>.


You should then log in using your regular Matrix client using <code>http://localhost:8009</code> as your server.
You should then log in using your regular Matrix client using <code><nowiki>http://localhost:8009</nowiki></code> as your server.


Related links
== Related links ==
=============


* [https://github.com/matrix-org/pantalaimon/tree/master/README.md the upstream readme]
* [https://github.com/matrix-org/pantalaimon/tree/master/README.md the upstream readme]
* [https://gitlab.alpinelinux.org/alpine/aports/-/merge_requests/8689 the initial MR]
* [https://gitlab.alpinelinux.org/alpine/aports/-/merge_requests/8689 the initial MR]

Latest revision as of 22:49, 3 September 2023

Pantalaimon is a Matrix proxy that handles end-to-end encryption support.

Installation

It can be installed with the pantalaimon package, and the panctl command line tool is in the pantalaimon-ui package.

Quickstart

There are two ways pantalaimon can be used: the first is to allow a bot access to an encrypted room, and the second is allowing a human to use access an encrypted room with a client that doesn't support end to end encryption yet. This wiki page currently only cover the second use case.

First, create a config file for pantalaimon at ~/.config/pantalaimon/pantalaimon.conf:

[MyMatrixServer]
Homeserver = https://matrix.myserver.xyz
ListenAddress = localhost
ListenPort = 8009

This is the minimal configuration file, but man 5 pantalaimon will allow you to explore the various options.

Then launch pantalaimon as your user. You can then control it through dbus using panctl.

You should then log in using your regular Matrix client using http://localhost:8009 as your server.

Related links