Some basics

Enabling the chat for you live streams

Varoitus

Instance administrators can choose to disable or enable chat in specific cases. Information in this section are only true in the default case.

When you create or modify a Peertube live, there is a “plugin settings” tab:

$Screenshot of the Peertube new live\nform.$ $Screenshot of the Peertube new live\nform.$

In the “plugin settings” tab, there is a “Use chat” checkbox. Just check or uncheck it to enable or disable the chat associated to your video.

$Screenshot of the form, with a “Use chat”\ncheckbox.$ $Screenshot of the form, with a “Use chat”\ncheckbox.$

Vihje

There can be other settings in this tab, depending on plugins installed on your Peertube instance.

Per channel chat

On the instance level, Peertube’s administrators can choose if chat rooms are unique per video, or if there will be an unique chat room per channel. Please contact your instance’s administrators for more information on how they configure the livechat plugin.

On top of the chat, there is a “Share chat link” button.

This button opens a popup, where you can obtain an url to join the chat. This url can be shared.

The “Embed” tab provide some links to embed the chat in websites, or in your live stream.

$Screenshot of the “Share chat link” dialog, where\nthe “Read-only” option is\nchecked.$ $Screenshot of the “Share chat link” dialog, where\nthe “Read-only” option is\nchecked.$

You can customize some options:

Read-only: you will only be able to read the chat, not write. This is useful to include the chat content in your live stream (see the OBS documentation).
Use current theme colors: if checked, your current theme colors will be added to the url, so that any user that opens the link will have the same color set.
Generate an iframe to embed the chat in a website: instead of an url, you will obtain an HTML snippet that you can add to your website to embed the chat.

For more information on the “Dock” tab, check the OBS documentation.

$Screenshot of the “Share chat link” dialog, on the\n“Dock tab. A token was generated, and is\nselectionable.”$ $Screenshot of the “Share chat link” dialog, on the\n“Dock tab. A token was generated, and is\nselectionable.”$

In the “Web” tab, the provided url opens the chat in the Peertube interface. You can share this link to other users to invite them to join the chat.

$Screenshot of the “Share chat link” dialog, on the\n“Web tab. There is a url you can\ncopy.$ $Screenshot of the “Share chat link” dialog, on the\n“Web tab. There is a url you can\ncopy.$

The “Share chat link” popup can also contain a “Connect using XMPP” tab. This will only be available if your instance’s administators have enabled an correctly configured this option. Using this option, you can provide a link to join the chat using any XMPP client software. Using such softwares can for example facilitate moderation actions.

$Screenshot of the “Share chat link” dialog, on the\n“Connect using XMPP”\ntab.$ $Screenshot of the “Share chat link” dialog, on the\n“Connect using XMPP”\ntab.$

Moderation

Please refer to the moderation documentation.

Include the chat in your video stream

Please refer to the OBS documentation.

Chat persistence

By default, the chat is persistent. This means that the room content will be kept for a while. User joining will see messages posted before their arrival.

You can change the persistence behaviour. Open the chat dropdown menu, and click on “Configure”.

$Screenshot of the dropdown menu at the top of the chat. Several entries\nare\navailable.$ $Screenshot of the dropdown menu at the top of the chat. Several entries\nare\navailable.$

There are several options that can be changed.

$Screenshot of the chat configuration\nform.$ $Screenshot of the chat configuration\nform.$

You can for example set the default and maximum number of messages to return to 0, so that new incomers won’t see any previously sent message.

You can also uncheck “enable archiving”: if unchecked, messages will be pruned if the server restarts.

By unchecking “Persistent”, the room will be cleared if there is no more participant.

Delete the chat content

If you want to delete the chat content, open the chat dropdown menu, then click on “Destroy”. A popup will open, asking a confirmation.

The chat will be automatically recreated each time someone tries to join it as long as the video exists, and has the “Use chat” feature activated.