doc/XMPP.md

Chat, VoIP and social network with

YunoHost comes installed with an instant messaging server Metronome which implements the XMPP protocol(previously known as Jabber), by default.

This protocol is already used by millions of people around the world - it is an open protocol. All applications based on XMPP are compatible with each other: when using an XMPP client, you can interact with anybody who has an XMPP account.

XMPP is an extensible protocol - this means users can configure "extensions" to chatrooms, to share messages and files, and to make voice and video calls using XMPP.

XMPP account

To use an XMPP account you need a username, which takes the format: user@domain.tld, and a password.

With YunoHost, an XMPP account is created for a registered account automatically. The XMPP account can be used with the main email address and her YunoHost password.

Connecting to your YunoHost XMPP account

You can connect to your YunoHost XMPP account in different ways.

Web clients

There are several XMPP web clients:

• Movim
• Libervia/Salut à Toi.

Desktop clients

You can also use a desktop client such as :

• Pidgin (multiplatform),
• Gajim (Linux, Windows),
• Dino (Linux),
• Thunderbird (multiplatform),
• Jitsi (multiplatform)
• Adium (Mac OS).

Mobile clients

Or a mobile client such as:

• Xabber (Android)
• Conversations (Android)
• Movim under Android
• Monal (iOS)

Here is an exhaustive list of XMPP clients : https://en.wikipedia.org/wiki/Comparison_of_XMPP_clients

Encrypt conversations with OMEMO

XMPP chats can be made secure and private using [OMEMO] encryption (https://xmpp.org/extensions/xep-0384.html), for instance using Gajim:

• Install gajim and the plugin gajim-omemo
• Enable the plugin in Tools > Plugins
• Enable it
• Enable the encryption in the chat with somebody who also has OMEMO

Chatrooms

To create a chatroom (multi-user chat) on your YunoHost server, use the identifier chatroomname@muc.yourdomain.tld.

For this to work you need to add the corresponding muc. DNS record in the DNS configuration.

VoIP and videoconferences

A practical tool to call an XMPP client, either with voice or voice+video, is to use the client Jitsi.