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

New documentation, first draft. WIP.

Browse Source
This commit is contained in:
John Livingston
2021-11-04 13:57:37 +01:00
parent 217b473d83
commit 729f95c5eb
15 changed files with 316 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,17 +1,20 @@
# PeerTube plugin livechat
# PeerTube plugin livechat 🇬🇧
This plugin is meant to provide web chat for Peertube videos.
🇫🇷 Version française [ici](README.fr.md).
**For release notes and breaking changes list, please see the [CHANGELOG](CHANGELOG.md) before updating the plugin.**
This [Peertube](https://joinpeertube.org/) plugin is meant to provide chat system for Peertube videos.
The plugin has to rely on an external tool as web chat backend. There are multiple ways to provide such functionality:
**IMPORTANT:** unfortunately this plugin does not (yet) work by itself, it must rely on external tools. Please read the [installation guide](documentation/installation.md).
* **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)
**Before updating to a major release, please read the release notes and breaking changes list : [CHANGELOG](CHANGELOG.md)**.
For the two first solutions, the connection to the XMPP server is made with the [converseJS](https://conversejs.org/) Javascript library.
XMPP is a protocol for chat applications. It is sometime known has Jabber.
## Documentation
* [installation guide](documentation/installation.md)
* [user guide](documentation/user.md)
* [administrator guide](documentation/admin.md)
## New features requests / Bug tracking
If you have new feature requests, bugs, or difficulties to setup the plugin, you can use the [Github issue tracker](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues).
@ -25,15 +28,9 @@ If you have any question, or if you want to talk about this plugin, you can join
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](https://liberapay.com/JohnLivingston/).
## Settings
## Contribute
For the chat mode, and related settings, please refer to the corresponding documentation:
* [Prosody server controlled by Peertube (recommended)](documentation/prosody.md). **This is the recommanded setup**.
* [Connect to an existing XMPP server with ConverseJS](documentation/conversejs.md)
* [Use an external web chat tool](documentation/external.md)
There are several common settings. Please see the documentation here: [common settings documentation](documentation/common.md).
Please refer to [CONTRIBUTING.md](CONTRIBUTING.md).
## Contribute
@ -41,13 +38,11 @@ Please refer to the page [CONTRIBUTING.md](CONTRIBUTING.md).
## Credits
[package.json](package.json), [COPYRIGHT](COPYRIGHT.md) and [LICENSE](LICENSE) files contain the license information for this software and its dependencies.
Thanks to David Revoy for his work on Peertube's mascot, [Sepia](https://www.davidrevoy.com/index.php?tag/peertube).
Some material icons downloaded from this website where used for icons: [Material.io](https://material.io/resources/icons)
Some Prosody Modules in the `prosody-modules` folder are under MIT license. Please refer to README files in each subfolder, and to the [COPYING](./prosody-modules/COPYING) file. For more informations, here is [the official Prosody Modules website](https://modules.prosody.im).
Thanks to [Framasoft](https://framasoft.org) for making [Peertube](https://joinpeertube.org/) possible, and for the support.
Thanks to [Framasoft](https://framasoft.org) for making [Peertube](https://joinpeertube.org/) possible, and for the financial support.
Thanks to [ritimo](https://www.ritimo.org/) for the financial support.