matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
NCTV fork of the livechat plugin.
381 Commits 3 Branches 2 Tags 49 MiB
TypeScript 59.3%
Lua 17.7%
JavaScript 16.9%
SCSS 5%
Shell 1%
26132e6d8e
Go to file
John Livingston 26132e6d8e
4.0.1
2021-09-14 16:56:30 +02:00
.github/ISSUE_TEMPLATE Removing funding file, it is now configured in a .github repo. 2021-08-30 13:10:45 +02:00
assets Some styles. 2021-07-20 01:18:01 +02:00
client Renaming. 2021-08-05 18:48:06 +02:00
conversejs Some comments. 2021-08-06 17:52:32 +02:00
docker Adding Dockerfile. 2021-06-01 20:41:20 +02:00
documentation Builtin Prosody: adding the prosody-room-type settings to allow rooms to be per channel or per video. WIP. 2021-08-05 15:41:49 +02:00
languages Updated for branch release/3.0.0 2021-06-14 12:03:19 +02:00
prosody-modules Adding last activity informations. 2021-07-19 16:51:51 +02:00
public/images Changed icons to have a material flavour 2021-03-08 19:18:01 +01:00
server Fix plugin register when Prosody enabled but not installed 2021-09-14 16:49:11 +02:00
shared Removed the settings «Chats are only available for local videos». 2021-08-05 18:45:06 +02:00
.eslintrc.json Eslint: configure for standard-typescript (backend), and separate configurations depending on folders. 2021-04-07 17:20:28 +02:00
.gitignore Adding eslint. 2021-02-20 11:55:00 +01:00
.markdownlint.jsonc Adding markdownlint file. 2021-08-05 11:58:31 +02:00
.npmignore
CHANGELOG.md Fix plugin register when Prosody enabled but not installed 2021-09-14 16:49:11 +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 4.0.1 2021-09-14 16:56:30 +02:00
package.json 4.0.1 2021-09-14 16:56:30 +02:00
README.md Liberapay profile. 2021-08-21 02:30:28 +02:00
ROADMAP.md Roadmap. 2021-08-05 18:49:14 +02:00
webpack.config.js Settings simplification to prepare translations. Diagnostic button is initialized by frontend. 2021-06-11 14:30:46 +02:00

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, or check my liberapay profile.

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.