New option to only allow registered users to speak WIP (#233):

* Prosody mod_muc_peertubelivechat_roles module
* Fix ConverseJS to disable the message field when room is unmoderated
  and user is visitor
* Mute/voice anonymous users when changing room configuration.
* Display a specific message to muted anonymous users.
* Default value for mute_anonymous in channel options.
* Feature documentation
This commit is contained in:
John Livingston
2024-06-20 16:46:14 +02:00
parent 1f1543bc97
commit 5a455fff93
57 changed files with 2959 additions and 944 deletions

View File

@ -1,7 +1,7 @@
---
title: "Channel configuration"
description: "Peertube channel chatrooms configuration"
weight: 30
weight: 20
chapter: false
---
@ -20,6 +20,7 @@ By clicking on a channel, you will then be able to setup some options for your c
Here you can configure:
* [{{% livechat_label livechat_configuration_channel_mute_anonymous_label %}}](/peertube-plugin-livechat/documentation/user/streamers/moderation) default value
* [The slow mode](/peertube-plugin-livechat/documentation/user/streamers/slow_mode)
* [The chat bot](/peertube-plugin-livechat/documentation/user/streamers/bot)
* [Custom emojis](/peertube-plugin-livechat/documentation/user/streamers/emojis)

View File

@ -1,7 +1,7 @@
---
title: "Moderation"
description: "Plugin peertube-plugin-livechat advanced moderation features"
weight: 60
weight: 30
chapter: false
---
@ -39,6 +39,30 @@ Clicking this button will give them owner access on the room.
You can use [ConverseJS moderation commands](https://conversejs.org/docs/html/features.html#moderating-chatrooms) to moderate the room.
When you open the chat room in full screen, there will also be a menu with dedicated commands on the top right.
## {{% livechat_label livechat_configuration_channel_mute_anonymous_label %}}
{{% notice info %}}
This feature comes with the livechat plugin version 10.2.0.
{{% /notice %}}
You can prevent anonymous users to send messages. In such case, only registered users will be able to talk in the chat.
To enable or disable this feature, use the [chat dropdown menu](/peertube-plugin-livechat/documentation/user/viewers), open the "configure" menu.
In the form, you will find a "{{% livechat_label livechat_configuration_channel_mute_anonymous_label %}}" checkbox.
![Room configuration / Mute anonymous users](/peertube-plugin-livechat/images/configure_mute_anonymous.png?classes=shadow,border&height=400px)
Anonymous users won't have the message field, and will see following prompt: "{{% livechat_label muted_anonymous_message %}}"
![Room configuration / Muted anonymous users](/peertube-plugin-livechat/images/anonymous_muted.png?classes=shadow,border&height=400px)
When this feature is enabled, anonymous users will be assigned the "visitor" role.
You can change their role to "participant" if you want to allow some of them to talk.
If you change the room configuration, all anonymous users will be muted or unmuted.
You can choose to enable or disable this feature for new chatrooms on the [channel configuration page](/peertube-plugin-livechat/documentation/user/streamers/channel).
## Roles and affiliations
There are several roles that can be assignated to users in chat rooms: owner, moderators, member, ...

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB