matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
24a036925b
peertube-plugin-livechat/README.md
John Livingston 62af899a50 Builtin Prosody modules: 
* initialize prosody modules folder
* comment on prosody modules licensing
* use mod_muc_http_defaults to set rooms properties and prevent unauthorized room creation WIP
2021-04-29 16:50:30 +02:00

2.6 KiB
Raw Blame History

PeerTube plugin livechat

This plugin can provide webchat for peertube videos.

There are multiple way to provide such functionality:

  • builtin prosody: this plugin can launch a Prosody process and auto-configure it. Documentation. Althought this is still experimental and under development, it is the recommanded setup.
  • builtin converseJS: you can use an external Jabber/XMPP server with BOSH or Websocket and anonymous loggin enabled. Documentation
  • external tool: you can use any external webchat tool, that can be included in an iframe. Documentation

For the two first solutions, the connection to the XMPP server is made with converseJS.

If you have new feature requests, bugs, or difficulties to setup the plugin, you can use the Github issue tracker.

Here is a roadmap for upcoming features: roadmap.

If you are a webdesigner or a ConverseJS/Prosody/XMPP expert, and want to help improve this plugin, you are welcome.

Contact me

If you have any question, or if you want to talk about this plugin, you can join this XMPP room with any Jabber client: plugin-livechat-support@room.im.yiny.org.

Settings

There are several common settings. Please see the documentation here: common settings documentation.

Then, please refer to the documentation associated with the mode you are planning to use:

  • builtin prosody: this plugin can launch a Prosody process and auto-configure it. Documentation
  • builtin converseJS: you can use an external Jabber/XMPP server with BOSH or Websocket and anonymous loggin enabled. Documentation
  • external tool: you can use any external webchat tool, that can be included in an iframe. Documentation

Credits

Thanks to David Revoy for his work on Peertube's mascot, Sepia.

Some material icons downloaded from this website where used for icons: Material.io

Some Prosody Modules in the prosody-modules folder are under MIT license. Please refer to README files in each subfolder, and to the COPYING file. For more informations, here is the official Prosody Modules website.