Peertube livechat

Tip

You can use the language selector in the left menu to view this documentation in different languages. Some translations are missing or incomplete. In this case, you’ll see the English version of the text.

$Screenshot of a Peertube video page, with a web chat on the right of the\nvideo.$ $Screenshot of a Peertube video page, with a web chat on the right of the\nvideo.$

Welcome the Peertube Livechat Plugin documentation.

Peertube is a decentralized streaming platform, that can provide both live streaming and VOD (Video On Demand) features. The present plugin adds chatting capatibilities to your Peertube installation, allowing viewers to interract with streamers.

To have a glimpse on this plugin capabilities, checkout the introduction. For more precise informations, please find bellow the summary of this documentation.

Tip

You can use the searchbox in the left menu to quickly find specific documentation parts.

Info

Before updating to a major release, please read the release notes and breaking changes list : CHANGELOG.

Introduction
Introduction
Documentation
Plugin documentation
- User documentation
  Plugin peertube-plugin-livechat user documentation
  - For viewers
    How to chat for stream viewers
  - OBS
    Documentation to stream the chat content using OBS.
  - XMPP Clients
    Connect to chat using a XMPP client
  - For streamers
    How to setup the chat for your live stream
    - Some basics
      Some basics about how to setup and use the chat for your live stream
    - Channel configuration
      Peertube channel chatrooms configuration
    - Announcements
      Room owners and administrators can send special announcements in the chat.
    - Moderation
      Plugin peertube-plugin-livechat advanced moderation features
    - Terms & conditions
      Configure channel's chat terms & conditions
    - Slow mode
      Plugin peertube-plugin-livechat slow mode
    - Moderation delay
      Plugin peertube-plugin-livechat moderation delay
    - Custom emojis
      Plugin peertube-plugin-livechat custom emojis
    - Emojis only mode
      Plugin peertube-plugin-livechat emojis only mode
    - Polls
      You can create polls to ask viewers their opinion
    - Tasks / To-do lists
      You can handle tasks and task lists with your moderation team.
    - Moderation notes
      Plugin peertube-plugin-livechat moderation notes
    - Chat bot
      Chat bot setup
- Installation guide
  Plugin peertube-plugin-livechat installation guide
  - Troubleshooting
    Some classic mistakes and workarounds.
  - Known issues: CPU Compatibility
    For now, the plugin only works out of the box for x86_64 and arm64 CPU architecture. Here are some instructions for other CPU architectures.
  - Upgrade from version older than 6.0.0
    Important notes when upgrading for an older version.
- Admin documentation
  Plugin Peertube Livechat administration
  - Settings
    Plugin Peertube Livechat settings
  - External Authentication
    Plugin Peertube Livechat settings - External Authentication
  - Prosody mod_firewall
    Advanced firewall rules for the Prosody server
  - Advanced usage
    Some advanced features
    - XMPP clients
      Allow connections using XMPP clients
    - Using Matterbridge
      Using Matterbridge to bridge with other chats
Contributing
Contributing
- Code of Conduct
  Contributor Covenant Code of Conduct
- Translate
  Translate the plugin
- Give your feedback
  Give your feedback
- Develop
  Develop
- Documentation
  Document the plugin, or translate the documentation.
Bug tracking & new features
Bug tracking / New features requests
Technical documentation
Technical documentation
- Source code
  Source code organization
- Third party
  Displaying the livechat with 3rd party software.
- Plugin storage
  Data files and folders used on the server
- MUC Slow mode
  MUC Slow mode XEP
- Polls
  Polls technical documentation
- Terms&Conditions
  Terms&Conditions implementation
- Tasks overview
  Task Application technical overview
- Moderator notes overview
  Moderator Notes Application technical overview
Contact me
Contact the author
Credits
Plugin Credits