As a Peertube administrator, you can setup this plugin on your instance simply by using the Peertube plugin marketplace included in the administration interface.Search for "livechat", then click "install": that's it!
874
support/documentation/content/en/intro/_index.md
The plugin has many advanced features.As it is using the [XMPP](https://xmpp.org/) standard "under the hood", it is possible for Peertube administrators to allow advanced usages (connection using XMPP clients, chatbots, bridge to other chat protocols, ...).More information in the relevant sections of this documentation.
This plugin can handle federation: when viewing a livestream from a remote instance, you will join the chat room with your local account.You will be automatically connected with your current nickname and avatar.
Some times, you have to protect your community from bad people.As an instance administrator, you can choose to disallow federation for the livechat plugin.If remote actors behave badly, streamers, moderators and administrators can ban or mute users.
This plugin comes with a built-in [chat bot](/peertube-plugin-livechat/documentation/user/streamers/bot/).Check its documentation for more information.
You can also plug in any other XMPP chat bot, using [XMPP External Components](https://prosody.im/doc/components).To do so, you just have to configure External Components access in the [plugin settings](/peertube-plugin-livechat/documentation/admin/settings).
When using software as [OBS](https://obsproject.com) for you livestream, you can embed the chat in the video stream.This is for example useful for replays.
In the following screenshot, you can see an OBS setup, where the chat is included as a source in the current scene (background color can be changed, and can be transparent):
