doc/XMPP.md

# Chat, VoIP and social network with <img src="/images/XMPP_logo.png" width=100>

YunoHost comes installed by default with an instant messaging server Metronome which implements the [XMPP protocol](https://en.wikipedia.org/wiki/Extensible_Messaging_and_Presence_Protocol) (previously known as Jabber).

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 all YunoHost users automatically. The XMPP account credentials corresponds to the user's main email address and password.

## Connecting to your YunoHost XMPP account

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

### Web clients

- [Movim](https://pod.movim.eu)
- [Libervia/Salut à Toi](http://salut-a-toi.org/).


### Desktop clients

- [Pidgin](http://pidgin.im/) (multiplatform),
- [Gajim](http://gajim.org/) (Linux, Windows),
- [Dino](https://dino.im) (Linux),
- [Thunderbird](https://www.thundebird.net/) (multiplatform),
- [Jitsi](http://jitsi.org/) (multiplatform)
- [Adium](https://adium.im/) (Mac OS).

### Mobile clients

- [Xabber](http://xabber.com) (Android)
- [Conversations](https://conversations.im/) (Android)
- [Movim under Android](https://movim.eu)
- [Monal](https://itunes.apple.com/us/app/monal-free-xmpp-chat/id317711500?mt=8) (iOS)
- [Kaidan](https://github.com/KaidanIM/Kaidan) (Ubuntu Touch / Plasma Mobile)

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](/dns_config) 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](http://jitsi.org/).