User XMPP clients documentation (#114)

This commit is contained in:
John Livingston 2023-04-14 13:29:05 +02:00
parent 1bd5c4decc
commit 02f27826b8
No known key found for this signature in database
GPG Key ID: B17B5640CE66CDBC
6 changed files with 112 additions and 0 deletions

View File

@ -0,0 +1,10 @@
+++
title="XMPP Clients"
description="Connect to chat using a XMPP client"
weight=40
chapter=false
+++
{{% notice warning %}}
This page is not yet translated in your language, please refer to the english version. You can switch to it by using the language selector in the left menu.
{{% /notice %}}

View File

@ -0,0 +1,45 @@
+++
title="XMPP Clients"
description="Connect to chat using a XMPP client"
weight=40
chapter=false
+++
This chat plugin relies on the XMPP protocol (also known as Jabber).
It is therefore possible to connect to the chats using
[XMPP client software](https://en.wikipedia.org/wiki/XMPP#Clients).
This can be useful for example to facilitate moderation operations.
{{% notice info %}}
The features described on this page must be enabled and configured by
your Peertube instance's administrators. You may therefore not have access to them.
{{% /notice %}}
## Login to your Peertube account
{{% notice warning %}}
This feature is not yet available, and will come in a future version of the plugin.
{{% /notice %}}
## Connection using an external XMPP account
If this feature is enabled on your instance, you can connect to Peertube
chats using any XMPP account.
To get the address of the room you want to join, you can use the "share chat"
button that is located above the chat:
![Share button](/peertube-plugin-livechat/images/share_button.png?classes=shadow,border&height=200px)
{{% notice info %}}
By default, the share button is only visible to the owner of the video,
and the admins/moderators of the instance.
However, admins can decide to display this button for everyone.
{{% /notice %}}
Then, choose "Connect using XMPP":
![Share XMPP](/peertube-plugin-livechat/images/share_xmpp_dialog.png?classes=shadow,border&height=200px)
Then you just have to click on "open" or copy/paste the address of the chat room into your XMPP client
(using the "join a room" feature).

View File

@ -0,0 +1,47 @@
+++
title="Clients XMPP"
description="Se connecter au tchat avec un client XMPP"
weight=40
chapter=false
+++
Ce module de tchat repose sur le protocole XMPP, aussi connu sous le nom de Jabber.
Il est donc possible de se connecter aux tchats en utilisant des
[logiciels clients XMPP](https://fr.wikipedia.org/wiki/Clients_XMPP).
Cela peut par exemple être utile pour faciliter les opérations de modération.
{{% notice info %}}
Les fonctions décrites dans cette page doivent être activées et configurées par
les administrateur⋅rices de votre instance Peertube. Il se peut donc que vous
n'y ayez pas accès.
{{% /notice %}}
## Connection à votre compte Peertube
{{% notice warning %}}
Cette fonctionnalité n'est pas encore disponible, et viendra dans une
prochaine version du plugin.
{{% /notice %}}
## Connection en utilisant un compte XMPP externe
Si cette fonctionnalité est activée sur votre instance, vous pouvez vous
connecter aux tchats Peertube en utilisant un compte XMPP quelconque.
Pour obtenir l'adresse du salon à rejoindre, vous pouvez utiliser la fenêtre
de «partage» du tchat, dont le bouton est situé au dessus du tchat:
![Partage](/peertube-plugin-livechat/images/share_button.png?classes=shadow,border&height=200px)
{{% notice info %}}
Par défaut, le bouton de partage n'est visible que pour le ou la propriétaire de la vidéo,
et les admins/modérateur⋅rices de l'instance.
Toutefois, les admins peuvent décider d'afficher ce bouton pour tout le monde.
{{% /notice %}}
Ensuite, dans la modale qui s'affiche, choississez «Connexion avec un client XMPP»:
![Partage XMPP](/peertube-plugin-livechat/images/share_xmpp_dialog.png?classes=shadow,border&height=200px)
Il vous suffit ensuite, soit de cliquer sur «ouvrir», soit de copier/coller l'adresse du salon dans votre client XMPP
(en utilisant la fonctionnalité «rejoindre un salon»).

View File

@ -0,0 +1,10 @@
+++
title="XMPP Clients"
description="Connect to chat using a XMPP client"
weight=40
chapter=false
+++
{{% notice warning %}}
This page is not yet translated in your language, please refer to the english version. You can switch to it by using the language selector in the left menu.
{{% /notice %}}

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB