matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
NCTV fork of the livechat plugin.
358 Commits 3 Branches 2 Tags 49 MiB
TypeScript 59.3%
Lua 17.7%
JavaScript 16.9%
SCSS 5%
Shell 1%
e14007f2e9
Go to file
John Livingston e14007f2e9
External webchat tool: new placeholder CHANNEL_ID in the webchat url.
2021-08-04 17:38:26 +02:00
.github/ISSUE_TEMPLATE
assets Some styles. 2021-07-20 01:18:01 +02:00
client External webchat tool: new placeholder CHANNEL_ID in the webchat url. 2021-08-04 17:38:26 +02:00
conversejs
docker
documentation External webchat tool: new placeholder CHANNEL_ID in the webchat url. 2021-08-04 17:38:26 +02:00
languages
prosody-modules Adding last activity informations. 2021-07-19 16:51:51 +02:00
public/images
server External webchat tool: new placeholder CHANNEL_ID in the webchat url. 2021-08-04 17:38:26 +02:00
shared Adding last activity informations. 2021-07-19 16:51:51 +02:00
.eslintrc.json
.gitignore
.npmignore
CHANGELOG.md External webchat tool: new placeholder CHANNEL_ID in the webchat url. 2021-08-04 17:38:26 +02:00
CODE_OF_CONDUCT.md Code of conduct. 2021-08-02 17:49:20 +02:00
CONTRIBUTING.md Adding a contribution guide, and an email contact. 2021-08-02 18:14:56 +02:00
LICENSE
package-lock.json
package.json Builtin ConverseJS on external XMPP server: new placeholders for the room name: CHANNEL_ID, CHANNEL_NAME. 2021-08-04 00:22:19 +02:00
README.md Adding a contribution guide, and an email contact. 2021-08-02 18:14:56 +02:00
ROADMAP.md Merge branch 'release/3.2.0' into main 2021-07-20 02:57:14 +02:00
webpack.config.js

README.md

PeerTube plugin livechat

This plugin is meant to provide web chat for Peertube videos.

For release notes and breaking changes list, please see the CHANGELOG 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 process and auto-configure it. Documentation. 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
  • Use an external web chat tool: you can use any external web chat tool, that can be included in an iframe. Documentation

For the two first solutions, the connection to the XMPP server is made with the converseJS Javascript library. XMPP is a protocol for chat applications. It is sometime known has Jabber.

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.

If you want to support the project financially, you can contact me by mail at git.[at].john-livingston.fr.

Settings

For the chat mode, and related settings, please refer to the corresponding documentation:

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

Contribute

Please refer to the page CONTRIBUTING.md.

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.

Thanks to Framasoft for making Peertube possible, and for the support.

Thanks to ritimo for the financial support.