PANTALAIMON(8)

💖 PANTALAIMON(8) 💖

okay bestie, welcome to the System Manager's Manual section 8, and today's main character is pantalaimon — an end-to-end encryption aware Matrix reverse proxy daemon. yes she's a daemon, yes she's serving, no you cannot skip this page. 🦋

---

✨ SYNOPSIS ✨

pantalaimon [-c config] [--log-level level] [--data-path path]
            [--version] [--help]

---

🌸 DESCRIPTION 🌸

so like. pantalaimon is a daemon that acts as a reverse proxy between a Matrix homeserver and a Matrix client, and she transparently handles end-to-end encryption tasks on behalf of the client. the client doesn't even have to know. she just does it. iconic behavior tbh 💅

she's supposed to run as your own user and listen to connections on a non-privileged port — no root nonsense, we don't do that here. a client needs to log in using the standard Matrix HTTP calls to register itself to the daemon, and a user registered like that is called a pan user. each pan user gets its own sync loop to keep up with the server, and multiple matrix clients can connect and use the same pan user. sharing is caring fr fr 🫶

if user interaction is required, pantalaimon will send out OS notifications which the user can react to. she also provides a D-Bus API that's used for encryption related tasks that require user interference (e.g. device verification). so like, when something needs you specifically, she'll let you know, no cap.

pantalaimon requires a homeserver to be configured. multiple homeservers can be configured, and each configured homeserver needs to listen on a separate port. each homeserver can handle end-to-end encryption for multiple users. the configuration file format is specified in pantalaimon(5), and the default location of the configuration file can be found in the “FILES” section down below. ⭐

🎀 Options 🎀

the command line flags to change the behaviour of pantalaimon are as follows:

• -c, --config file — use the supplied file as the configuration file instead of the default one. 💖
• --log-level level — set the log level of the daemon, can be one of error, warning, info, debug. defaults to warning. 🦋
• --data-path path — set the directory for the pantalaimon database. this config option takes precedence over the XDG environment variables. 👑
• --version — display the version number and exit. ✨
• --help — display the help and exit. 🌸

---

🧚 FILES 🧚

pantalaimon supports the XDG Base Directory Specification, and the default locations can be overridden using appropriate environment variables. so like, if you want her files somewhere else, she's flexible. 💜

• ~/.config/pantalaimon/pantalaimon.conf — default location of the configuration file. the format of the configuration file is described in pantalaimon(5). 📝
• ~/.local/share/pantalaimon/pan.db — default location of the pantalaimon database. this file is used to store a sqlite database holding daemon state and encryption keys. 🔐

---

💀 EXIT STATUS 💀

the pantalaimon utility exits 0 on success, and >0 if an error occurs. simple as that, bestie. 😭

---

🌈 SEE ALSO 🌈

panctl(1) pantalaimon(5)

---

👑 AUTHORS 👑

pantalaimon was written by Damir Jelić <poljar@termina.org.uk>. 💖

---

okay that's the whole page, you ate that. 💅 this was the Debian build, dated Oct 18, 2019 — go forth and proxy, bestie, ily 🫶✨