matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Ref to changelog.

Browse Source
This commit is contained in:
John Livingston 2021-07-20 10:40:58 +02:00
parent a4b501e305
commit 8bbcd3c851
No known key found for this signature in database
GPG Key ID: B17B5640CE66CDBC
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -2,10 +2,10 @@
This plugin is meant to provide web chat for Peertube videos.
The plugin has to rely on an external tool as web chat backend. There are multiple ways to provide such functionality:
**For release notes and breaking changes list, please see the [CHANGELOG](CHANGELOG.md) before updating the plugin.**
The plugin has to rely on an external tool as web chat backend. There are multiple ways to provide such functionality:
* **Prosody server controlled by Peertube (recommended):** this plugin can launch a [Prosody](https://prosody.im) process and auto-configure it. [Documentation](documentation/prosody.md). **This is the recommanded setup, and is almost automatic to setup**.
* **Connect to an existing XMPP server with ConverseJS:** you can use an external Jabber/XMPP server. This server has to provide BOSH or Websocket API, accept anonymous loggin, and accept room creation. [Documentation](documentation/conversejs.md)
* **Use an external web chat tool:** you can use any external web chat tool, that can be included in an iframe. [Documentation](documentation/external.md)