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-02-19 19:38:39 +01:00
parent 5f67c4b0f7
commit a5de35c567
4 changed files with 176 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -9,9 +9,9 @@ This is under development. It is not functional yet.
For now, there is no documentation for how you can setup the webchat.
It has to be setup by your own. For example with a XMPP Server and the ConverseJS Javascript.
Next step: document how you can setup the XMPP server.
## XMPP backend with ConverseJS
## ConverseJS
### ConverseJS
Once you have a XMPP server that allow anonymous authentication, with bosh
(or websocket) enabled, you can - for example - setup a html page that looks like
@ -21,3 +21,42 @@ by your actual domain.
NB : there is a bug in the converseJS 7.0.4 release. The dist files don't work.
So if you are not building converseJS yourself, use version 7.0.3 instead.
NB: for converseJS to find your server configuration (bosh, websocket, ...),
you have to add a file [/.well-known/host-meta](documentation/examples/converseJS/host-meta).
Please refer to the converseJS documentation.
### XMPP Server: Prosody
You can use Prosody for the XMPP backend.
You can find an example configuration file [here](documentation/examples/prosody/virtualhost.cfg.lua).
You have to place this file in /etc/prosody/conf.avail/your_domain.cfg.lua.
Replace peertube.im.your_domain with the domain you want.
There must be a DNS record for that domain.
NB : no need to have a DNS record for room.peertube.im.your_domain.
To create the certificate, you can use certbot with letsencrypt:
```certbot certonly --nginx --emailyour_email -d peertube.im.your_domain```
Then:
```prosodyctl --root cert import /etc/letsencrypt/live/```
Please refer to the [Prosody documentation](https://prosody.im/doc/).
NB : if you have not nginx on your server, please replace by the correct parameter.
### XMPP over HTTP: nginx
You can use the reverse proxy nginx to server the Prosody Bosh server.
So your requests will be on the 443 port, and it will minimise cross domains constraints.
There is an example file [here](documentation/examples/nginx/site.conf).
NB: this example files also serve the static html files with converseJS.