peertube-plugin-livechat/README.md

# PeerTube plugin livechat

This plugin can provide webchat for peertube videos.

There are multiple way to provide such functionality:

* **builtin prosody:** this plugin can launch a [Prosody](https://prosody.im) process and auto-configure it. [Documentation](documentation/prosody.md). Althought this is still experimental and under development, it is the recommanded setup.
* **builtin converseJS:** you can use an external Jabber/XMPP server with BOSH or Websocket and anonymous loggin enabled. [Documentation](documentation/conversejs.md)
* **external tool:** you can use any external webchat tool, that can be included in an iframe. [Documentation](documentation/external.md)

For the two first solutions, the connection to the XMPP server is made with [converseJS](https://conversejs.org/).

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).

Here is a roadmap for upcoming features: [roadmap](ROADMAP.md).

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](xmpp:plugin-livechat-support@room.im.yiny.org?join).

## Settings

There are several common settings. Please see the documentation here: [common settings documentation](documentation/common.md).

Then, please refer to the documentation associated with the mode you are planning to use:

* **builtin prosody:** this plugin can launch a [Prosody](https://prosody.im) process and auto-configure it. [Documentation](documentation/prosody.md)
* **builtin converseJS:** you can use an external Jabber/XMPP server with BOSH or Websocket and anonymous loggin enabled. [Documentation](documentation/conversejs.md)
* **external tool:** you can use any external webchat tool, that can be included in an iframe. [Documentation](documentation/external.md)

## Credits

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).
Documentation 2021-02-20 23:02:31 +00:00			`# PeerTube plugin livechat`
Add doc link in readme 2020-08-21 07:49:48 +00:00
Documentation 2021-02-20 23:02:31 +00:00			`This plugin can provide webchat for peertube videos.`
Initial release. 2021-02-18 17:31:12 +00:00
Documentation 2021-02-20 23:02:31 +00:00			`There are multiple way to provide such functionality:`
Initial release. 2021-02-18 17:31:12 +00:00
Documentation. 2021-04-16 15:55:48 +00:00			`* builtin prosody: this plugin can launch a [Prosody](https://prosody.im) process and auto-configure it. [Documentation](documentation/prosody.md). Althought this is still experimental and under development, it is the recommanded setup.`
			`* builtin converseJS: you can use an external Jabber/XMPP server with BOSH or Websocket and anonymous loggin enabled. [Documentation](documentation/conversejs.md)`
			`* external tool: you can use any external webchat tool, that can be included in an iframe. [Documentation](documentation/external.md)`
Initial release. 2021-02-18 17:31:12 +00:00
Documentation. 2021-04-16 15:55:48 +00:00			`For the two first solutions, the connection to the XMPP server is made with [converseJS](https://conversejs.org/).`
Documentation 2021-02-20 23:02:31 +00:00
			`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).`

Roadmap in README. 2021-04-29 11:45:01 +00:00			`Here is a roadmap for upcoming features: [roadmap](ROADMAP.md).`

Documentation 2021-02-20 23:02:31 +00:00			`If you are a webdesigner or a ConverseJS/Prosody/XMPP expert, and want to help improve this plugin, you are welcome.`
Documentation 2021-02-19 18:57:18 +00:00
Documentation 2021-02-22 18:41:37 +00:00			`## Contact me`
Added support room Jid 2021-02-22 13:40:58 +00:00
Fix XMPP address 2021-03-02 15:18:27 +00:00			`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](xmpp:plugin-livechat-support@room.im.yiny.org?join).`
Added support room Jid 2021-02-22 13:40:58 +00:00
Documentation 2021-02-19 18:57:18 +00:00			`## Settings`

Documentation. 2021-04-16 15:55:48 +00:00			`There are several common settings. Please see the documentation here: [common settings documentation](documentation/common.md).`
Documentation 2021-02-19 18:38:39 +00:00
Documentation. 2021-04-16 15:55:48 +00:00			`Then, please refer to the documentation associated with the mode you are planning to use:`
Documentation 2021-02-19 18:44:19 +00:00
Documentation. 2021-04-16 15:55:48 +00:00			`* builtin prosody: this plugin can launch a [Prosody](https://prosody.im) process and auto-configure it. [Documentation](documentation/prosody.md)`
			`* builtin converseJS: you can use an external Jabber/XMPP server with BOSH or Websocket and anonymous loggin enabled. [Documentation](documentation/conversejs.md)`
			`* external tool: you can use any external webchat tool, that can be included in an iframe. [Documentation](documentation/external.md)`
Better UX * All buttons are in the same DOM container as the iframe * Icons for buttons * Rewriting the build process * Simplier state management * Buttons are hidden using CSS 2021-03-01 17:38:39 +00:00
			`## Credits`

Update README.md 2021-03-09 17:20:49 +00:00			`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)`
Builtin Prosody modules: * initialize prosody modules folder * comment on prosody modules licensing * use mod_muc_http_defaults to set rooms properties and prevent unauthorized room creation WIP 2021-04-29 14:50:30 +00:00
			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).