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

Documentation.

Browse Source
This commit is contained in:
John Livingston
2021-06-11 18:32:32 +02:00
parent 52b39af5c8
commit f77f9bb3c7
6 changed files with 86 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
documentation/prosody.md
View File

@ -1,9 +1,20 @@
# Builtin Prosody XMPP Server
# Prosody server controlled by Peertube
Althought this mode is still experimental and under heavy development, it is the recommanded setup mode.
This is the recommended setup mode for this plugin.
Peertube will launch a [Prosody](https://prosody.im) process, with a custom configuration.
Prosody is a Free and Open Source XMPP/Jabber server software.
With this mode, the Peertube server will be able to communicate with the Prosody server, with following features:
- auto login: if a user is logged in on the Peertube instance, it will be automatically authenticated in the web chat
- access rights: Peertube instance's administrators and moderators will automatically be owner for all created chat rooms.
- access rights: the Peertube's user who has added the video will automatically be moderator on the chat room.
- moderation tools will be enabled
- it will not be possible to create a room that is not linked to a video
- chat room will automatically get some informations from the video (title, ...)
## Prerequisite
### For standard Peertube installations
@ -23,6 +34,8 @@ sudo systemctl disable prosody && sudo systemctl stop prosody
And that's it!
The Prosody process launched by the plugin will listen on a specific port, and only on the localhost interface.
You don't to open any external port on your firewall.
The default local port will be 52800 and can be changed in the plugin settings.
### For Docker installations
@ -35,24 +48,23 @@ You can find the source for this Dockerfile [here](../docker/Dockerfile.buster).
## Settings
### Common settings
### Chat mode
First you have to configure [common settings](./common.md).
Just select «Prosody server controlled by Peertube» as chat mode.
Then, left settings related to the [builtin converseJS](./conversejs.md) blank, and fill following settings according to this page.
### Use the builtin Prosody XMPP Server
Check this checkbox to activate this mode.
#### Builtin prosody: Prosody port
#### Prosody port
This is the port that the Prosody server will use. By default it is set to 52800. If you want to use another port, just change the value here.
### Chat behaviour
These settings are common with other chat modes.
Here is the documentation: [common settings](./common.md).
## Notes
All instance moderators and admins will be owner for created chat rooms.
If the video is local (not from a remote Peertube), the video owner will be admin in the chat room.
You can use [ConverseJS moderation commands](https://conversejs.org/docs/html/features.html#moderating-chatrooms) to moderate the room.
When you open the chat room in full screen, there will also be a menu with dedicated commands in the top right.
When you open the chat room in full screen, there will also be a menu with dedicated commands on the top right.