Dock documentation.

This commit is contained in:
John Livingston
2024-06-19 12:17:03 +02:00
parent 22ea1a36ae
commit 252dd04a13
47 changed files with 4134 additions and 452 deletions

View File

@ -68,3 +68,12 @@ NoTLS=true
- The setting `NoTLS=true` allows connecting to a server with self-signed certificates.
Now you can add this account to gateways and bridge specific live-chat channels.
{{% notice info %}}
This documentation use an anonymous account to connect the bridge to the chat.
But since the livechat v10.1.0, there is a new way to generate long term authentication token, that allows to connect using your account.
This is used for [OBS docks](/peertube-plugin-livechat/documentation/user/obs).
Using this feature for other purposes is not documented and not officially supported yet.
If you want to use it anyway, you can request a token by calling then `/plugins/livechat/router/api/auth/tokens` endpoint.
To get needed headers and request body, just check what happens when you generate a new token for OBS docks.
{{% /notice %}}

View File

@ -10,7 +10,7 @@ In the current page, you will find some advices to handle your live chats using
## OBS Overlay
You can easily include the chat in your stream.
You can easily include the chat in your video stream.
![Embeding the chat in a live stream](/peertube-plugin-livechat/images/embed_chat_in_livestream.png?classes=shadow,border&height=200px)
@ -40,6 +40,48 @@ Note: you can entirely customize chat colors. This is undocumented yet, but you
in the modal, check «use curent theme colors», then you can try to manually change color values in the URL.
You must use valid CSS color values, and they must be properly URL encoded.
## OBS Dock
{{% notice info %}}
This feature comes with the livechat plugin version 10.1.0.
{{% /notice %}}
{{% notice warning %}}
This feature can be disabled by the instance's adminitrators.
{{% /notice %}}
You can use OBS "Custom browser docks" to integrate the chat in your OBS while you are streaming.
The livechat plugin offers a way to create long term token that can identify you automatically to join the chat, so you don't have to enter your password in OBS.
To do so, just use the "{{% livechat_label share_chat_link %}}", and open the "{{% livechat_label share_chat_dock %}}" tab.
From there, you can create a new token using the "+" button.
![Share link popup - dock tab](/peertube-plugin-livechat/images/share_dock.png?classes=shadow,border&height=200px)
Then, copy the url, and use the "Docks / Custom browser docks" menu from your OBS to add a dock with this URL.
![OBS - Dock menu](/peertube-plugin-livechat/images/obs_dock_menu.png?classes=shadow,border&height=200px)
![OBS - Dock dialog](/peertube-plugin-livechat/images/obs_dock_dialog.png?classes=shadow,border&height=200px)
Once you have done, you will have a new dock connected to the chat with your account.
![OBS - Dock](/peertube-plugin-livechat/images/obs_dock.png?classes=shadow,border&height=200px)
{{% notice tip %}}
Tokens are valid to join any chat room. You don't have to generate separate tokens for each of your rooms.
You can also customize the nickame that will be used by changing the `n` parameter in the url.
{{% /notice %}}
Don't share these links to anyone, as it would allow them to connect as yourself.
If a token is compromised, or no more needed, you can revoke them.
{{% notice info %}}
These tokens can be used for other purposes, as connecting to your account with XMPP bots or clients.
This feature is not documented yet, and not officially supported. So use with care.
{{% /notice %}}
## Mixing multiple chats in your live stream
You can use the [social_stream browser extension](https://github.com/steveseguin/social_stream#readme) to mix multiple chat source (from Peertube, Twitch, Youtube, Facebook, ...) and include their contents in your live stream.

View File

@ -37,6 +37,8 @@ On top of the chat, there is a "{{% livechat_label 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 "{{% livechat_label share_chat_embed %}}" tab provide some links to embed the chat in websites, or in your live stream.
![Share link popup](/peertube-plugin-livechat/images/share_readonly.png?classes=shadow,border&height=200px)
You can customize some options:
@ -45,11 +47,22 @@ You can customize some options:
* {{% livechat_label use_current_theme_color %}}: 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.
* {{% livechat_label generate_iframe %}}: 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 "{{% livechat_label share_chat_dock %}}" tab, check the [OBS documentation](/peertube-plugin-livechat/documentation/user/obs).
![Share link popup - dock tab](/peertube-plugin-livechat/images/share_dock.png?classes=shadow,border&height=200px)
In the "{{% livechat_label 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.
![Share link popup - web tab](/peertube-plugin-livechat/images/share_web.png?classes=shadow,border&height=200px)
The "{{% livechat_label share_chat_link %}}" popup can also contain a "{{% livechat_label 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](https://en.wikipedia.org/wiki/XMPP#Clients).
Using such softwares can for example facilitate moderation actions.
![Share link popup - xmpp tab](/peertube-plugin-livechat/images/share_xmpp_dialog.png?classes=shadow,border&height=200px)
## Moderation
Please refer to the [moderation documentation](/peertube-plugin-livechat/documentation/user/streamers/moderation).

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 150 KiB

After

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 64 KiB