Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update xmpp.md #2392

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion pages/02.administer/15.admin_guide/40.xmpp/xmpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,30 @@ The XMPP account credentials corresponds to the user's main e-mail address and p

If you wish to know more about using XMPP, refer to the [User guide](/XMPP).

## Manual configuration
### Configure BOSH
BOSH is a functionality required so that other softwares can access you XMPP server like Conversejs or JSXC, the XMPP client for NextCloud.

The Metronome module is already activated by default, you just need to install a blank app to make the service BOSH accessible from outside, by installing the app Redirect : yunohost app install redirect -a "domain=your.domain&path=/http-bind&redirect_path=http://localhost:5290/http-bind&redirect_type=public_proxy" -l BOSH

Source : https://forum.yunohost.org/t/unable-to-set-up-bosh-conf-nginx/12995 https://forum.yunohost.org/t/configure-xmpp-in-nextcloud-addon-javascript-xmpp-client/2934/4?u=ashledombos

### Configure TURN/STUN
This service is needed to by able to have audio/video calls in Conversations.
See configuration in https://github.com/YunoHost/issues/issues/1607

### Extend supported MIME-type
By default, many filetype cannot be sent when using this server.
See configuration in https://forum.yunohost.org/t/metronome-mime-types-for-metronome-again/20073

## Know limitations of Metronome in Yunohost
* https://github.com/maranda/metronome/issues/549

## Incompatibility with Prosody

Prosody, an alternative XMPP server, is packaged for YunoHost.

It is notably used by Peertube's chat feature, and Jitsi for video conferences. Installing these apps will install Prosody, which needs to disable Metronome to work properly.

! In summary, installing Prosody or an app relying on it will disable the XMPP server.
! In summary, installing Prosody or an app relying on it will disable the XMPP server.
! A proof of concept of switch from Metronome to Prosody has been documented https://sebseb01.net/blog/2023-poc-yunohost-metronome-prosody (french); experiemental, use at your own risk !