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

Documentation update + remove docker build:

Browse Source 
* Update documentation and removed deprecated parts
* removed Docker image build files, as it is no more needed
This commit is contained in:
John Livingston
2022-11-15 18:04:51 +01:00
parent 3ba64d3732
commit 187d8be87f
28 changed files with 234 additions and 959 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
documentation/installation.md
View File

@ -3,19 +3,14 @@
🇫🇷 French version / Version française [ici](./installation.fr.md)
🇩🇪 German version / deutsche Version [hier](./installation.de.md)
**IMPORTANT:** unfortunately this plugin does not (yet) work by itself, it must rely on external tools.
**Before updating to a major release, please read the release notes and breaking changes list : [CHANGELOG](../CHANGELOG.md)**.
This plugin can be used in different ways:
To install or update the plugin, just use the Peertube web admin interface.
| Mode | Description | Documentation
---|---|---
**Prosody server controlled by Peertube (recommended)** | This plugin can launch a [Prosody](https://prosody.im) process and auto-configure it | [Prosody+Peertube installation](./prosody.md). **This is the recommanded mode, 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 login, and accept room creation. | [ConverseJS+XMPP installation](./conversejs.md)
**Use an external web chat tool** | You can use any external web chat tool, that can be included in an iframe. | [External chat installation](./external.md)
## IMPORTANT NOTE
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.
Since version v6.0.0, this plugin does not need any Prosody installation.
There are some documentation for common settings here: [common settings documentation](./common.md).
If you were using this plugin before this version, and if you had installed Prosody manually, you can safely uninstall Prosody.
If you were using the custom Peertube docker image that is embedding Prosody, you can switch back to the official Peertube image.