This commit concerns the first subtask of this issue: https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/117 It provide a brand new documentation website, that replace the previous markdown files. The website is auto-generated using CI/CD, and can be found here: https://johnxlivingston.github.io/peertube-plugin-livechat/
This commit is contained in:
John Livingston
GitHub
@ -1,161 +1,2 @@
|
||||
# Plugin Peertube Livechat administration
|
||||
|
||||
## Settings
|
||||
|
||||
This section describes the plugin settings page.
|
||||
|
||||
### List existing rooms
|
||||
|
||||
When pressing the «List rooms» button, all existing chatrooms will be listed.
|
||||
You can then find them and moderated them.
|
||||
|
||||
### Chat behaviour
|
||||
|
||||
#### Room type
|
||||
|
||||
You can choose here to have separate rooms for each video, or to group them by channel.
|
||||
|
||||
#### Automatically open the chat
|
||||
|
||||
If checked, the chat will be loaded as soon as you are on the video page.
|
||||
|
||||
#### Show the «open in new window» button
|
||||
|
||||
If your web chat tool can be opened in a full window, you can add a button to do so.
|
||||
|
||||
If you are using an external web chat tool (see the chat mode «Use an external web chat tool»), maybe it will not work in fullscreen (for example if it needs to access the parent window to get video informations). You can disable this button by unchecking this settings.
|
||||
|
||||
#### Show the «share chat link» button
|
||||
|
||||
This feature enables a «share chat link» modal. With this modal, you can generate URLs to join the chat.
|
||||
The chat can be customized (readonly mode, use the current theme, ...).
|
||||
|
||||
You can for example generate a readonly URL and use it in OBS to integrate the chat in your live stream!
|
||||
|
||||
This settings allows you to choose who can access this modal.
|
||||
|
||||
#### Chats are only available for local videos
|
||||
|
||||
Peertube is a federated service. Plugins are only available on the server you are browsing.
|
||||
So, if you are watching a remote video, only you will have the webchat, not users from remote instances.
|
||||
Therefore, this options is checked by default and prevent displaying a webchat for remote videos.
|
||||
|
||||
#### Users can activate the chat for their lives
|
||||
|
||||
If checked, all live videos will have a checkbox in their properties for enabling the web chat.
|
||||
The video owner will be able to activate web chats.
|
||||
|
||||
#### Activate chat for all lives
|
||||
|
||||
The chat will be available for all Peertube live videos on your instance.
|
||||
|
||||
#### Activate chat for all non-lives
|
||||
|
||||
The chat will be available for all Peertube video that are not live.
|
||||
|
||||
#### Activate chat for these videos
|
||||
|
||||
You can choose some UUIDs for which the chat will be available.
|
||||
If you don't want te enable the feature for all videos, you can use this field to list videos UUIDs.
|
||||
You can add comments: everything rights to the # character will be stripped off, as for empty lines.
|
||||
|
||||
#### Hide the chat for anonymous users
|
||||
|
||||
If checked, anonymous Peertube users won't see the chat.
|
||||
|
||||
Note: for now this feature simply hide the chat.
|
||||
In a future release, the chat will be replaced by a message saying «please log in to [...]».
|
||||
See [v5.7.0 Release Notes](https://github.com/JohnXLivingston/peertube-plugin-livechat/blob/main/CHANGELOG.md#570) for more information.
|
||||
|
||||
### Theming
|
||||
|
||||
#### ConverseJS theme
|
||||
|
||||
You can choose which theme to use for ConverseJS:
|
||||
|
||||
- Peertube theme: this is a special theme, made especially for peertube's integration.
|
||||
- Default ConverseJS theme: this is the default ConverseJS theme.
|
||||
- ConverseJS concord theme: this is a theme provided by ConverseJS.
|
||||
|
||||
#### Automatic color detection
|
||||
|
||||
Try to auto detect colors from user's current theme.
|
||||
When this settings is enabled, the plugin tries to auto-detect colors to apply to the chat theme.
|
||||
If this is not correctly working for some of your Peertube theme, you can disable this option.
|
||||
|
||||
#### Webchat iframe style attribute
|
||||
|
||||
You can add some custom styles that will be added to the iframe.
|
||||
For example a custom width:
|
||||
|
||||
```width:400px;```
|
||||
|
||||
### Chat server advanced settings
|
||||
|
||||
#### Use system Prosody
|
||||
|
||||
The plugin comes with an AppImage that is used to run the [Prosody XMPP server](https://prosody.im).
|
||||
If this AppImage is not working, you can fallback to the Prosody that is packaged for your server. Just install the `prosody` package.
|
||||
|
||||
This settings should only be used if the plugin is broken, and waiting for a patch.
|
||||
|
||||
#### Disable Websocket
|
||||
|
||||
With Peertube >= 5.0.0, this plugin try to use Websocket connection for chatting.
|
||||
If the user's browser or connection is not compatible, the browser will automatically fallback on the BOSH protocol.
|
||||
|
||||
But in rare case, this can fail. For example if you have a reverse proxy in front of Peertube that does not
|
||||
allow Websocket connection for plugins.
|
||||
In this case, you can check this settings to disable Websocket connections.
|
||||
|
||||
#### Prosody port
|
||||
|
||||
This is the port that the Prosody server will use. By default it is set to 52800. If you want to use another port, just change the value here.
|
||||
|
||||
#### Peertube URL for API calls
|
||||
|
||||
In some rare cases, Prosody can't call Peertube's API from its public URI.
|
||||
If you have such issues (see the diagnostic tool result), you can try to set the value
|
||||
of this settings to `http://localhost:9000` or `http://127.0.0.1:9000`
|
||||
(supposing your Peertube is listening on port `9000`. Check that in your Peertube `config/production.yaml` file).
|
||||
|
||||
#### Log rooms content by default
|
||||
|
||||
If checked, room content will be archived on the server by default.
|
||||
This means that users who join the chan will see messages sent before they have joined.
|
||||
|
||||
Please note that it is always possible to enable/disable the content logging for a specific room,
|
||||
by editing its properties.
|
||||
|
||||
#### Room logs expiration
|
||||
|
||||
You can set here the expiration delay for room logs.
|
||||
See the online help for accepted values.
|
||||
|
||||
#### Enable client to server connections
|
||||
|
||||
This setting enable XMPP clients to connect to the builtin Prosody server.
|
||||
For now, this option **only allows connections from localhost clients**.
|
||||
|
||||
As example, this option can allow an instance of Matterbridge (once it could use anonymous login) *on the same machine* to bridge your chat with another services like a Matrix room.
|
||||
|
||||
##### Prosody client to server port
|
||||
|
||||
The port that will be used by the c2s module of the builtin Prosody server.
|
||||
XMPP clients shall use this port to connect.
|
||||
Change it if this port is already in use on your server.
|
||||
|
||||
#### Enable external XMPP components
|
||||
|
||||
This settings enable XMPP external components to connect to the server.
|
||||
For now, this option **only allows connections from localhost components**.
|
||||
|
||||
This feature could be used to connect bridges or bots.
|
||||
|
||||
More informations on Prosody external components [here](https://prosody.im/doc/components).
|
||||
|
||||
## Advanced usages
|
||||
|
||||
### Using Matterbridge
|
||||
|
||||
Here is a tutorial to use Matterbridge with the plugin: <https://gitlab.com/refrac/obs-matterbridge-overlay/-/blob/master/documentation/peertube.md>
|
||||
**This page as moved here:
|
||||
[Plugin Livechat Documentation](https://johnxlivingston.github.io/peertube-plugin-livechat/documentation/admin/).**
|
||||
|
||||
@ -1,81 +1,2 @@
|
||||
# Plugin peertube-plugin-livechat Installationsanleitung 🇩🇪
|
||||
|
||||
🇫🇷 French version / Version française [ici](./installation.fr.md).
|
||||
🇬🇧 English version / version anglaise [here](./installation.md).
|
||||
🇯🇵 Japanese version / 日本語バージョン [こちら](./installation.ja.md).
|
||||
|
||||
**Bevor Sie auf eine Hauptversion aktualisieren, lesen Sie bitte die Versionshinweise und die Liste der wichtigsten Änderungen : [CHANGELOG](CHANGELOG.md)**.
|
||||
|
||||
To install or update the plugin, just use the Peertube web admin interface.
|
||||
|
||||
## IMPORTANT NOTE
|
||||
|
||||
Since version v6.0.0, this plugin does not need any Prosody installation.
|
||||
|
||||
If you were using this plugin before this version, and if you had installed Prosody manually, you can safely uninstall Prosody.
|
||||
|
||||
If you were using the custom Peertube docker image that is embedding Prosody, you can switch back to the official Peertube image.
|
||||
|
||||
## Known issues: CPU compatibility
|
||||
|
||||
The Prosody AppImage included in the plugin will only work on x86_64 CPU.
|
||||
It is not compatible with arm64 and other CPU architectures.
|
||||
|
||||
For now, I did not manage to make it work for other CPU architectures.
|
||||
If you want te be notified when it will be possible, you can subscribe and comment this
|
||||
[issue](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/124).
|
||||
|
||||
To use the plugin, you will have to manually install Prosody on your server
|
||||
(see below).
|
||||
|
||||
Once it is done, you have to check `Use system Prosody` in the plugin settings.
|
||||
|
||||
### On non-docker Peertube installation
|
||||
|
||||
For standard installation, you just have to install the official `prosody` package
|
||||
for your linux distribution.
|
||||
|
||||
For example, on Debian/Ubuntu:
|
||||
|
||||
```bash
|
||||
sudo apt install prosody
|
||||
```
|
||||
|
||||
You can then disable the service that starts automatically when you install
|
||||
Prosody (the plugin will launch a Prosody process, there is no need for the
|
||||
service to run).
|
||||
For example, on Debian/Ubuntu (and other Systemd based linux distributions):
|
||||
|
||||
```bash
|
||||
sudo systemctl disable prosody && sudo systemctl stop prosody
|
||||
```
|
||||
|
||||
Warning: do not disable Prosody if it is used for another service on your server,
|
||||
like for example Jitsi.
|
||||
|
||||
### Docker
|
||||
|
||||
You will have to generate a Peertube image that includes Prosody in the same
|
||||
container that Peertube.
|
||||
I know this is not the standard way to do this with Docker, but keep in mind it
|
||||
is a temporary workaround.
|
||||
|
||||
To generate and use such an image, please refer to the Docker documentation.
|
||||
The Docker file to generate the image should be:
|
||||
|
||||
```Docker
|
||||
FROM chocobozzz/peertube:production-bullseye
|
||||
|
||||
RUN apt -y update && apt install -y prosody && apt -y clean
|
||||
```
|
||||
|
||||
### Yunohost
|
||||
|
||||
You have to disable `metronome` (the XMPP server provided by Yunohost), and
|
||||
install `prosody`.
|
||||
|
||||
This is already done by the Yunohost Peertube application, as it was required for the
|
||||
plugin before the v6.0.0.
|
||||
But it may be removed in a near feature (to avoid drawbacks of this method).
|
||||
I have to discuss with Yunohost team, to decide how we can do to minimize drawbacks,
|
||||
and maximize compatibility.
|
||||
**This page as moved here:
|
||||
[Plugin Livechat Documentation](https://johnxlivingston.github.io/peertube-plugin-livechat/de/documentation/installation/).**
|
||||
|
||||
@ -1,83 +1,2 @@
|
||||
# Installation du plugin peertube-plugin-livechat 🇫🇷
|
||||
|
||||
🇬🇧 English version / version anglaise [here](./installation.md).
|
||||
🇩🇪 German version / deutsche Version [hier](./installation.de.md).
|
||||
🇯🇵 Japanese version / 日本語バージョン [こちら](./installation.ja.md).
|
||||
|
||||
**Avant de mettre à jour vers une nouvelle version majeure, merci de lire les notes de version, et la liste des éventuelles modifications non rétro-compatibles : [CHANGELOG](../CHANGELOG.md).**
|
||||
|
||||
Pour installer ou mettre à jour ce plugin, utilisez simplement l'interface web d'administration de votre Peertube.
|
||||
|
||||
## IMPORTANT NOTE
|
||||
|
||||
Depuis la version v6.0.0, ce plugin ne nécessite plus l'installation de Prosody.
|
||||
|
||||
Si vous utilisiez ce plugin avant, et que vous aviez installé Prosody manuellement, vous pouvez le désinstaller en tout sécurité.
|
||||
|
||||
Si vous utilisiez l'image docker spéciale de Peertube (qui incluais Prosody), vous pouvez basculer sur l'image officielle de Peertube.
|
||||
|
||||
## Problème connu: compatibilité CPU
|
||||
|
||||
L'AppImage Prosody inclue dans le plugin ne fonctionne que sur des CPU x86_64.
|
||||
Elle n'est pas compatible avec d'autres architectures CPU telles que arm64.
|
||||
|
||||
Pour l'instant, je n'ai pas réussi à le faire fonctionner sur d'autres architectures.
|
||||
Pour être notifié des évolutions sur le sujet, vous pouvez vous abonner et commenter
|
||||
[ce ticket](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/124).
|
||||
|
||||
Pour utiliser le plugin, vous allez devoir installer manuellement Prosody sur
|
||||
votre serveur (voir plus bas).
|
||||
|
||||
Une fois cela fait, vous aurez à cocher le paramètre `Use system Prosody` du plugin.
|
||||
|
||||
### Installation autres que Docker
|
||||
|
||||
Pour les installations standard, vous avez juste à installer le paquet `prosody` officiellement
|
||||
disponible pour votre distribution linux.
|
||||
|
||||
Par exemple, sur Debian/Ubuntu:
|
||||
|
||||
```bash
|
||||
sudo apt install prosody
|
||||
```
|
||||
|
||||
Vous pouvez alors désactiver le service qui démarre automatiquement quand vous
|
||||
installé le paquet (le plugin va lancer son propre processus Prosody, et n'a pas
|
||||
besoin que le service tourne sur le serveur).
|
||||
Par exemple, sur Debian/Ubuntu (et les autres distributions se basant sur Systemd):
|
||||
|
||||
```bash
|
||||
sudo systemctl disable prosody && sudo systemctl stop prosody
|
||||
```
|
||||
|
||||
Attention: ne désactivez pas Prosody s'il est utilisé par un autre service sur
|
||||
votre serveur, par exemple pour Jitsi.
|
||||
|
||||
### Docker
|
||||
|
||||
Vous allez devoir générer une image de Peertube qui inclu Prosody dans le même
|
||||
conteneur que Peertube.
|
||||
Je sais que ce n'est pas la façon de faire standard avec Docker, mais gardez
|
||||
en tête que ceci est une solution de contournement temporaire.
|
||||
|
||||
Pour générer cette image, merci de vous référer à la documentation de Docker.
|
||||
Le fichier Docker pour générer l'image devrait être:
|
||||
|
||||
```Docker
|
||||
FROM chocobozzz/peertube:production-bullseye
|
||||
|
||||
RUN apt -y update && apt install -y prosody && apt -y clean
|
||||
```
|
||||
|
||||
### Yunohost
|
||||
|
||||
Vous avez à désactiver `metronome` (le serveur XMPP utilisé par Yunohost),
|
||||
et installer`prosody`.
|
||||
|
||||
Ceci est déjà fait par l'application Yunohost Peertube, étant donné que c'était
|
||||
un pré-requis pour les version du plugin antérieures à la v6.0.0.
|
||||
|
||||
Mais il se pourrait que ce soit retiré de l'application Yunohost Peertube dans un
|
||||
futur proche (pour éviter les inconvénients de cette méthode).
|
||||
Je dois discuter avec l'équipe Yunohost, pour décider de la bonne façon de faire
|
||||
pour minimiser les inconvénients et maximiser la compatibilité.
|
||||
**Cette page a été déplacée ici :
|
||||
[Plugin Livechat Documentation](https://johnxlivingston.github.io/peertube-plugin-livechat/fr/documentation/installation/).**
|
||||
|
||||
@ -1,82 +1,2 @@
|
||||
# Plugin peertube-plugin-livechat installation guide 🇬🇧
|
||||
|
||||
🇬🇧 English version / version anglaise [here](./installation.md).
|
||||
🇫🇷 French version / Version française [ici](./installation.fr.md).
|
||||
🇩🇪 German version / deutsche Version [hier](./installation.de.md).
|
||||
🇯🇵 Japanese version / 日本語バージョン [こちら](./installation.ja.md).
|
||||
|
||||
**メジャーリリースのアップデート実施前に、リリースノートをお読み頂き、変更をご確認ください : [変更履歴](../CHANGELOG.md)**.
|
||||
|
||||
本プラグインをインストールまたはアップデートは、PeerTubeの管理画面から実施できます。
|
||||
|
||||
## 重要事項
|
||||
|
||||
v6.0.0から、このプラグインはProsodyのインストールが不要になりました。
|
||||
|
||||
このバージョンより前の環境で本プラグインを既にご使用中で、手動でProsodyをインストールした場合は、Prosodyのアンインストールが可能です。
|
||||
|
||||
Prosodyが内蔵されたカスタムDockerイメージをご利用の場合は、公式のPeerTube Dockerイメージに切り替えることができるようになりました。
|
||||
|
||||
## Known issues: CPU compatibility
|
||||
|
||||
The Prosody AppImage included in the plugin will only work on x86_64 CPU.
|
||||
It is not compatible with arm64 and other CPU architectures.
|
||||
|
||||
For now, I did not manage to make it work for other CPU architectures.
|
||||
If you want te be notified when it will be possible, you can subscribe and comment this
|
||||
[issue](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/124).
|
||||
|
||||
To use the plugin, you will have to manually install Prosody on your server
|
||||
(see below).
|
||||
|
||||
Once it is done, you have to check `Use system Prosody` in the plugin settings.
|
||||
|
||||
### On non-docker Peertube installation
|
||||
|
||||
For standard installation, you just have to install the official `prosody` package
|
||||
for your linux distribution.
|
||||
|
||||
For example, on Debian/Ubuntu:
|
||||
|
||||
```bash
|
||||
sudo apt install prosody
|
||||
```
|
||||
|
||||
You can then disable the service that starts automatically when you install
|
||||
Prosody (the plugin will launch a Prosody process, there is no need for the
|
||||
service to run).
|
||||
For example, on Debian/Ubuntu (and other Systemd based linux distributions):
|
||||
|
||||
```bash
|
||||
sudo systemctl disable prosody && sudo systemctl stop prosody
|
||||
```
|
||||
|
||||
Warning: do not disable Prosody if it is used for another service on your server,
|
||||
like for example Jitsi.
|
||||
|
||||
### Docker
|
||||
|
||||
You will have to generate a Peertube image that includes Prosody in the same
|
||||
container that Peertube.
|
||||
I know this is not the standard way to do this with Docker, but keep in mind it
|
||||
is a temporary workaround.
|
||||
|
||||
To generate and use such an image, please refer to the Docker documentation.
|
||||
The Docker file to generate the image should be:
|
||||
|
||||
```Docker
|
||||
FROM chocobozzz/peertube:production-bullseye
|
||||
|
||||
RUN apt -y update && apt install -y prosody && apt -y clean
|
||||
```
|
||||
|
||||
### Yunohost
|
||||
|
||||
You have to disable `metronome` (the XMPP server provided by Yunohost), and
|
||||
install `prosody`.
|
||||
|
||||
This is already done by the Yunohost Peertube application, as it was required for the
|
||||
plugin before the v6.0.0.
|
||||
But it may be removed in a near feature (to avoid drawbacks of this method).
|
||||
I have to discuss with Yunohost team, to decide how we can do to minimize drawbacks,
|
||||
and maximize compatibility.
|
||||
**This page as moved here:
|
||||
[Plugin Livechat Documentation](https://johnxlivingston.github.io/peertube-plugin-livechat/ja/documentation/installation/).**
|
||||
|
||||
@ -1,81 +1,2 @@
|
||||
# Plugin peertube-plugin-livechat installation guide 🇬🇧
|
||||
|
||||
🇫🇷 French version / Version française [ici](./installation.fr.md)
|
||||
🇩🇪 German version / deutsche Version [hier](./installation.de.md)
|
||||
🇯🇵 Japanese version / 日本語バージョン [こちら](./installation.ja.md)
|
||||
|
||||
**Before updating to a major release, please read the release notes and breaking changes list : [CHANGELOG](../CHANGELOG.md)**.
|
||||
|
||||
To install or update the plugin, just use the Peertube web admin interface.
|
||||
|
||||
## IMPORTANT NOTE
|
||||
|
||||
Since version v6.0.0, this plugin does not need any Prosody installation.
|
||||
|
||||
If you were using this plugin before this version, and if you had installed Prosody manually, you can safely uninstall Prosody.
|
||||
|
||||
If you were using the custom Peertube docker image that is embedding Prosody, you can switch back to the official Peertube image.
|
||||
|
||||
## Known issues: CPU compatibility
|
||||
|
||||
The Prosody AppImage included in the plugin will only work on x86_64 CPU.
|
||||
It is not compatible with arm64 and other CPU architectures.
|
||||
|
||||
For now, I did not manage to make it work for other CPU architectures.
|
||||
If you want te be notified when it will be possible, you can subscribe and comment this
|
||||
[issue](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/124).
|
||||
|
||||
To use the plugin, you will have to manually install Prosody on your server
|
||||
(see below).
|
||||
|
||||
Once it is done, you have to check `Use system Prosody` in the plugin settings.
|
||||
|
||||
### On non-docker Peertube installation
|
||||
|
||||
For standard installation, you just have to install the official `prosody` package
|
||||
for your linux distribution.
|
||||
|
||||
For example, on Debian/Ubuntu:
|
||||
|
||||
```bash
|
||||
sudo apt install prosody
|
||||
```
|
||||
|
||||
You can then disable the service that starts automatically when you install
|
||||
Prosody (the plugin will launch a Prosody process, there is no need for the
|
||||
service to run).
|
||||
For example, on Debian/Ubuntu (and other Systemd based linux distributions):
|
||||
|
||||
```bash
|
||||
sudo systemctl disable prosody && sudo systemctl stop prosody
|
||||
```
|
||||
|
||||
Warning: do not disable Prosody if it is used for another service on your server,
|
||||
like for example Jitsi.
|
||||
|
||||
### Docker
|
||||
|
||||
You will have to generate a Peertube image that includes Prosody in the same
|
||||
container that Peertube.
|
||||
I know this is not the standard way to do this with Docker, but keep in mind it
|
||||
is a temporary workaround.
|
||||
|
||||
To generate and use such an image, please refer to the Docker documentation.
|
||||
The Docker file to generate the image should be:
|
||||
|
||||
```Docker
|
||||
FROM chocobozzz/peertube:production-bullseye
|
||||
|
||||
RUN apt -y update && apt install -y prosody && apt -y clean
|
||||
```
|
||||
|
||||
### Yunohost
|
||||
|
||||
You have to disable `metronome` (the XMPP server provided by Yunohost), and
|
||||
install `prosody`.
|
||||
|
||||
This is already done by the Yunohost Peertube application, as it was required for the
|
||||
plugin before the v6.0.0.
|
||||
But it may be removed in a near feature (to avoid drawbacks of this method).
|
||||
I have to discuss with Yunohost team, to decide how we can do to minimize drawbacks,
|
||||
and maximize compatibility.
|
||||
**This page as moved here:
|
||||
[Plugin Livechat Documentation](https://johnxlivingston.github.io/peertube-plugin-livechat/documentation/installation/).**
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 189 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 40 KiB |
@ -1,46 +1,2 @@
|
||||
# User documentation
|
||||
|
||||
## Moderation
|
||||
|
||||
You can access room settings and moderation tools by opening the chat in a new window,
|
||||
and using the dropdown menu at the top right.
|
||||
|
||||
You can list all existing chatrooms: in the plugin settings screen, there is a button «List rooms».
|
||||
|
||||
You can delete old rooms: join the room, and use the menu on the top to destroy the room.
|
||||
|
||||
### Notes
|
||||
|
||||
All instance moderators and admins will be owner of created chat rooms.
|
||||
If the video is local (not from a remote Peertube), the video owner will be admin in the chat 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.
|
||||
|
||||
## OBS Overlay
|
||||
|
||||
If you are using OBS for streaming, you can easily include the chat in your stream.
|
||||
|
||||
You can use the «share chat link» feature to generate an URL to your chat.
|
||||
The button should be near the chat if you are the video owner (unless it was desactivated by your server admins).
|
||||
|
||||
Check the «readonly» checkbox in the modal.
|
||||
Then use this link as a «web browser source» in OBS.
|
||||
|
||||
You can use the «Transparent background» to have a transparent background in OBS.
|
||||
If you want to customize the background transparency, you can add this CSS in your OBS browser source's settings:
|
||||
|
||||
```css
|
||||
:root {
|
||||
--livechat-transparent: rgba(255 255 255 / 90%) !important;
|
||||
}
|
||||
```
|
||||
|
||||
Note: you can customize colors. This is undocumented yet, but you can try this:
|
||||
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.
|
||||
|
||||
### 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.
|
||||
The compatibility with this plugin was added in recent versions.
|
||||
**This page as moved here:
|
||||
[Plugin Livechat Documentation](https://johnxlivingston.github.io/peertube-plugin-livechat/documentation/user/).**
|
||||
|
||||
Reference in New Issue
Block a user