peertube-plugin-livechat/CHANGELOG.md

# Changelog

## ???

### Features

* Possibility to have webchat per channel (see [this request](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/58))
  * Builtin Prosody: instance's admins can choose if rooms are per video, or grouped by channel. Only one settings for the whole instance.
  * Builtin ConverseJS on external XMPP server: new placeholders for the room name: CHANNEL_ID, CHANNEL_NAME.
  * External webchat tool: new placeholder CHANNEL_ID in the webchat url.

### Fixes

* Builtin Prosody: Fix [#63](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/63). On some old Peertube installations, there can be usernames with upper-case letters. Adding a toLowerCase() for the XMPP jid.

## v3.2.0

### Features

* Builtin Prosody: list existing rooms in the settings page
* Builtin Prosody: new settings to enable local C2S. For example, can be used with Matterbridge (thanks [https://github.com/tytan652](https://github.com/tytan652))

### Fixes

* Fix broken API diagnostic.

## v3.1.0

### Features

* Builtin Prosody: optional settings to change the url for Prosody's API calls.
* Diagnostic tool: testing API communication from Peertube to Prosody.
* Diagnostic tool: testing API communication from Prosody to Peertube.
* Diagnostic tool: correctly parse Prosody nightly build versions.

## v3.0.0

### Important Notes

* This version requires at least Peertube version 3.2.0. It is no more compatible with previous Peertube versions.

### Features

* New simpler settings screen.
* New field in live video form, to activate the webchat per video. There is a setting for enabling this new feature.

### Changes

* Removed compatibility with Peertube previous to 3.2.0.
* Restoring default values for checkboxes in settings (there was a bug with Peertube previous to 3.2.0)
* New settings
* By default, the «activate chat for all lives» is disabled (now that we can enable the webchat per video)

## v2.3.1

### Features

* Added Dockerfile to use builtin prosody in Peertube docker installations.

### Fixes

* Fix typo: builtin prosody won't stop when desactivated.

## v2.3.0

### Features

* Builtin prosody use a working dir provided by Peertube (needs Peertube >= 3.2.0)
* Starting with Peertube 3.2.0, builtin prosody save room history on server. So when a user connects, he can get previously send messages.
* Starting with Peertube 3.2.0, builtin prosody also activate mod_muc_moderation, enabling moderators to moderate messages.
* Prosody log level will be the same as the Peertube's one.
* Prosody log rotation every 24 hour.
* ConverseJS is using sessionStorage rather than localStorage.

### Peertube 3.2.0

* Use peertubeHelpers.plugin methods when available. Backward compatibility is maintained.
* Use new DOM placeholder for webchat when available.

### Fixes

* Builtin Prosody: settings archive_expires_after was useless without mod_mam

## v2.2.1

### Fixes

* Revert «Better default values for settings», because of a [bug in Peertube](https://github.com/Chocobozzz/PeerTube/issues/4106)

## v2.2.0

### Features

* Don't display webchat when viewing a playlist (requires Peertube 3.2.0).
* Better default values for settings.
* Settings: hide unnecessary settings depending on webchat mode (requires Peertube 3.2.0).

### Fixes

* Fix: starting with Peertube 3.2.0, there is a header 'X-Frame-Options'. Removing it on the iframe route.
* Remove old Peertube 3.0.1 compatibility (default value for checkbox settings should be false)

## v2.1.3

* Fix: 2.1.0 was in fact correct... Did not work on my preprod env because of... a Livebox bug...
* Fix: if the video owner is already owner of the chatroom, he should not be downgraded to admin.

## v2.1.2

* Fix: revert 2.1.1, and revert using the real domain for prosody

## v2.1.1

* Fix bad proxy settings when not working on localhost

## v2.1.0

### Important Notes

* This version requires at least Peertube version 3.1.0. It is no more compatible with Peertube 3.0.1.

### Features

* Builtin Prosody: use mod_muc_http_defaults to set rooms properties and prevent unauthorized room creation.
* Builtin Prosody: use mod_auth_http to auto login peertube users
* Builtin Prosody: instance's admins and moderators are owner of all created room. Video's owner is admin of the room.

### Fixes

* Fix converseJS: show the participant list when not in iframe

## v2.0.3

* Fix Peertube server crash when prosody is not installed

## v2.0.2

* Trying to fix dependencies installation problems

## v2.0.1

* Trying to fix dependencies installation problems

## v2.0.0

* Code is now in Typescript
* Builtin Prosody server, for easy configuration
* Diagnostic tools for helping admins to find misconfigurations

## v1.0.8

* Fix: typo that can prevent settings chat-only-locals to work

## v1.0.7

* New tutorial to setup [Prosody on the Peertube server](documentation/tutorials/prosody.md)
* Add link to documentation in the settings page.

## v1.0.6

* New icons by [Porrumentzio](https://github.com/Porrumentzio)

## v1.0.5

* New buttons and logo.
* Fix: changing default value to false for every checkbox settings (Peertube bug in <=3.0.1: [https://github.com/Chocobozzz/PeerTube/issues/3838](https://github.com/Chocobozzz/PeerTube/issues/3838)).

## v1.0.4

### Features

* Translations for ca, eo, es and eu. Thanks to [Porrumentzio](https://github.com/Porrumentzio).
* UX improvments. Buttons are now icons, and placed on top of the chat container.

### Bug Fixes

* Fix buttons disappearing when lives started of finished.

## v1.0.3

### Various changes

* Using converseJS ^7.0.4
* Updating documentation

## v1.0.2

### Bug fixes

* Quick fix: add a min-height for the iframe, so that it is not too tiny when under the video.

## v1.0.1

### Bug fixes

* When installing the plugin from npm, the node_modules don't come with: copying converseJS to dist folder.

## v1.0.0

### Features

* Optional Builtin ConverseJS
* Option for enabling live only on local videos
* The «open in new window» button is optional

## v0.0.8

### Features

* The chat is displayed on the right of the video

## v0.0.7

### Bug Fixes

* Fix incomplete commit

## v0.0.6

### Features

* Use eslint to lint the code

### Bug fixes

* Fix dom positionning
* Chat should be displayed for waiting and ended lives
* Chat and chat buttons must be cleaned out of the dom on navigation

## v0.0.5

* Initial release
Changelog 2021-02-20 13:22:24 +00:00			`# Changelog`

Builtin ConverseJS on external XMPP server: new placeholders for the room name: CHANNEL_ID, CHANNEL_NAME. 2021-08-03 22:22:19 +00:00			`## ???`

			`### Features`

External webchat tool: new placeholder CHANNEL_ID in the webchat url. 2021-08-04 15:38:26 +00:00			`* Possibility to have webchat per channel (see [this request](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/58))`
Updating changelog and co. 2021-08-05 16:37:40 +00:00			`* Builtin Prosody: instance's admins can choose if rooms are per video, or grouped by channel. Only one settings for the whole instance.`
External webchat tool: new placeholder CHANNEL_ID in the webchat url. 2021-08-04 15:38:26 +00:00			`* Builtin ConverseJS on external XMPP server: new placeholders for the room name: CHANNEL_ID, CHANNEL_NAME.`
			`* External webchat tool: new placeholder CHANNEL_ID in the webchat url.`
Builtin ConverseJS on external XMPP server: new placeholders for the room name: CHANNEL_ID, CHANNEL_NAME. 2021-08-03 22:22:19 +00:00
Fix #63: On some old Peertube installations, there can be usernames with upper-case letters. Adding a toLowerCase() for the XMPP jid. 2021-08-05 09:51:16 +00:00			`### Fixes`

			`* Builtin Prosody: Fix [#63](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/63). On some old Peertube installations, there can be usernames with upper-case letters. Adding a toLowerCase() for the XMPP jid.`

Initializing v3.2.0. 2021-06-22 11:42:34 +00:00			`## v3.2.0`
3.1.0 init. 2021-06-17 08:45:04 +00:00
Changelog. 2021-07-14 16:48:24 +00:00			`### Features`

Changelog 2021-07-14 17:21:56 +00:00			`* Builtin Prosody: list existing rooms in the settings page`
Fix #63: On some old Peertube installations, there can be usernames with upper-case letters. Adding a toLowerCase() for the XMPP jid. 2021-08-05 09:51:16 +00:00			`* Builtin Prosody: new settings to enable local C2S. For example, can be used with Matterbridge (thanks [https://github.com/tytan652](https://github.com/tytan652))`
3.1.0 init. 2021-06-17 08:45:04 +00:00
Fix broken API diagnostic. * Moving http_peertubelivechat_test module in muc component, as the global config has no http_host. * Adding Host HTTP Header to API call from Peertube to Prosody 2021-07-20 00:52:58 +00:00			`### Fixes`

			`* Fix broken API diagnostic.`

3.1.0 init. 2021-06-17 08:45:04 +00:00			`## v3.1.0`

Diagnostic tool: testing API communication between Peertube and Prosody. 2021-06-22 08:26:45 +00:00			`### Features`

Builtin Prosody: optional settings to change the url for Prosody's API calls. 2021-06-22 11:23:01 +00:00			`* Builtin Prosody: optional settings to change the url for Prosody's API calls.`
Diagnostic tool: testing API communication from Prosody to Peertube. 2021-06-22 10:57:24 +00:00			`* Diagnostic tool: testing API communication from Peertube to Prosody.`
			`* Diagnostic tool: testing API communication from Prosody to Peertube.`
Diagnostic tool: correctly parse Prosody nightly build versions. 2021-06-22 11:28:15 +00:00			`* Diagnostic tool: correctly parse Prosody nightly build versions.`
3.1.0 init. 2021-06-17 08:45:04 +00:00
Changelog... 2021-06-02 10:06:24 +00:00			`## v3.0.0`

			`### Important Notes`

			`* This version requires at least Peertube version 3.2.0. It is no more compatible with previous Peertube versions.`

			`### Features`

Changelog and roadmap. 2021-06-03 10:00:21 +00:00			`* New simpler settings screen.`
Chat can be enabled in video properties. 2021-06-08 16:08:58 +00:00			`* New field in live video form, to activate the webchat per video. There is a setting for enabling this new feature.`
Changelog... 2021-06-02 10:06:24 +00:00
			`### Changes`

			`* Removed compatibility with Peertube previous to 3.2.0.`
Remove backward compatibility (restoring default values for checkboxes). 2021-06-02 13:56:12 +00:00			`* Restoring default values for checkboxes in settings (there was a bug with Peertube previous to 3.2.0)`
Chat can be enabled in video properties. 2021-06-08 16:08:58 +00:00			`* New settings`
			`* By default, the «activate chat for all lives» is disabled (now that we can enable the webchat per video)`
Changelog... 2021-06-02 10:06:24 +00:00
Fix typo: builtin prosody wont stop when desactivated. 2021-06-02 14:10:56 +00:00			`## v2.3.1`

Changelog. 2021-06-02 14:12:14 +00:00			`### Features`

			`* Added Dockerfile to use builtin prosody in Peertube docker installations.`

Fix typo: builtin prosody wont stop when desactivated. 2021-06-02 14:10:56 +00:00			`### Fixes`

			`* Fix typo: builtin prosody won't stop when desactivated.`

Version 2021-05-27 12:08:17 +00:00			`## v2.3.0`
Builtin prosody use a working dir provided by Peertube. 2021-05-11 13:37:34 +00:00
			`### Features`

			`* Builtin prosody use a working dir provided by Peertube (needs Peertube >= 3.2.0)`
Using mod_muc_mam: * Starting with Peertube 3.2.0, builtin prosody save room history on server. So when a user connects, he can get previously send messages. * Fix: settings archive_expires_after was useless without mod_mam 2021-05-11 14:10:57 +00:00			`* Starting with Peertube 3.2.0, builtin prosody save room history on server. So when a user connects, he can get previously send messages.`
Update comment after more tests. 2021-05-11 15:31:20 +00:00			`* Starting with Peertube 3.2.0, builtin prosody also activate mod_muc_moderation, enabling moderators to moderate messages.`
Prosody log level will be the same as the Peertube's one. 2021-05-12 09:48:38 +00:00			`* Prosody log level will be the same as the Peertube's one.`
Prosody log rotation every 24 hour. 2021-05-12 12:59:52 +00:00			`* Prosody log rotation every 24 hour.`
ConverseJS is using sessionStorage rather than localStorage. 2021-05-18 17:09:29 +00:00			`* ConverseJS is using sessionStorage rather than localStorage.`
Using mod_muc_mam: * Starting with Peertube 3.2.0, builtin prosody save room history on server. So when a user connects, he can get previously send messages. * Fix: settings archive_expires_after was useless without mod_mam 2021-05-11 14:10:57 +00:00
Use peertubeHelpers.plugin methods when available: * getBaseStaticRoute use peertubeHelper when available * getBaseRouter renamed getBaseRouterRoute and use peertubeHelper when available * Backward compatibility is maintained. 2021-05-18 16:06:11 +00:00			`### Peertube 3.2.0`

			`* Use peertubeHelpers.plugin methods when available. Backward compatibility is maintained.`
CHANGELOG.md 2021-05-26 12:21:35 +00:00			`* Use new DOM placeholder for webchat when available.`
Use peertubeHelpers.plugin methods when available: * getBaseStaticRoute use peertubeHelper when available * getBaseRouter renamed getBaseRouterRoute and use peertubeHelper when available * Backward compatibility is maintained. 2021-05-18 16:06:11 +00:00
Using mod_muc_mam: * Starting with Peertube 3.2.0, builtin prosody save room history on server. So when a user connects, he can get previously send messages. * Fix: settings archive_expires_after was useless without mod_mam 2021-05-11 14:10:57 +00:00			`### Fixes`

			`* Builtin Prosody: settings archive_expires_after was useless without mod_mam`
Builtin prosody use a working dir provided by Peertube. 2021-05-11 13:37:34 +00:00
Revert «Better default values for settings», because of a bug in Peertube. 2021-05-18 18:51:07 +00:00			`## v2.2.1`

			`### Fixes`

			`* Revert «Better default values for settings», because of a [bug in Peertube](https://github.com/Chocobozzz/PeerTube/issues/4106)`

Changelog 2021-05-11 08:06:39 +00:00			`## v2.2.0`
Fix: starting with Peertube 3.2.0, there is a header X-Frame-Options. Removing it on the iframe route. 2021-05-07 14:45:55 +00:00
Don't display webchat when viewing a playlist: * remove old Peertube 3.0.1 hook compatibility * use new parameters for hook action:video-watch.video.loaded (Peertube 3.2.0) * backward compatibility with Peertube 3.1.0 hooks * don't display webchat if there is a current playlist 2021-05-07 16:52:01 +00:00			`### Features`

Updating Changelog. 2021-05-10 09:16:25 +00:00			`* Don't display webchat when viewing a playlist (requires Peertube 3.2.0).`
Better default values for settings: * Remove old Peertube 3.0.1 compatibility (default value for checkbox settings should be false) 2021-05-07 17:18:41 +00:00			`* Better default values for settings.`
Settings: hide unnecessary settings depending on webchat mode (requires Peertube 3.2.0). 2021-05-10 19:04:04 +00:00			`* Settings: hide unnecessary settings depending on webchat mode (requires Peertube 3.2.0).`
Don't display webchat when viewing a playlist: * remove old Peertube 3.0.1 hook compatibility * use new parameters for hook action:video-watch.video.loaded (Peertube 3.2.0) * backward compatibility with Peertube 3.1.0 hooks * don't display webchat if there is a current playlist 2021-05-07 16:52:01 +00:00
Fix: starting with Peertube 3.2.0, there is a header X-Frame-Options. Removing it on the iframe route. 2021-05-07 14:45:55 +00:00			`### Fixes`

			`* Fix: starting with Peertube 3.2.0, there is a header 'X-Frame-Options'. Removing it on the iframe route.`
Better default values for settings: * Remove old Peertube 3.0.1 compatibility (default value for checkbox settings should be false) 2021-05-07 17:18:41 +00:00			`* Remove old Peertube 3.0.1 compatibility (default value for checkbox settings should be false)`
Fix: starting with Peertube 3.2.0, there is a header X-Frame-Options. Removing it on the iframe route. 2021-05-07 14:45:55 +00:00
Fix: 2.1.0 was in fact correct... Did not work on my preprod env because of... a Livebox bug... 2021-05-06 19:00:42 +00:00			`## v2.1.3`

			`* Fix: 2.1.0 was in fact correct... Did not work on my preprod env because of... a Livebox bug...`
Fix: if the video owner is already owner of the chatroom, he should not be downgraded to admin. 2021-05-06 19:05:46 +00:00			`* Fix: if the video owner is already owner of the chatroom, he should not be downgraded to admin.`
Fix: 2.1.0 was in fact correct... Did not work on my preprod env because of... a Livebox bug... 2021-05-06 19:00:42 +00:00
Revert getProsodyDomain. Broken when not on localhot. 2021-05-06 12:04:16 +00:00			`## v2.1.2`

			`* Fix: revert 2.1.1, and revert using the real domain for prosody`

Trying to fix for production. 2021-05-06 11:59:45 +00:00			`## v2.1.1`

			`* Fix bad proxy settings when not working on localhost`

Bump version to v2.1.0. 2021-05-06 11:33:30 +00:00			`## v2.1.0`
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
Removing a hack: * replacing loadByUrl by loadByIdOrUuid * breaks compatibility with peertube 3.0.1 * simpler webchat route * fix uuid escaping in iframe uri 2021-04-30 15:39:27 +00:00			`### Important Notes`

			`* This version requires at least Peertube version 3.1.0. It is no more compatible with Peertube 3.0.1.`

			`### Features`

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			`* Builtin Prosody: use mod_muc_http_defaults to set rooms properties and prevent unauthorized room creation.`
Changelog. 2021-05-04 09:30:00 +00:00			`* Builtin Prosody: use mod_auth_http to auto login peertube users`
Changelog 2021-05-06 10:37:49 +00:00			`* Builtin Prosody: instance's admins and moderators are owner of all created room. Video's owner is admin of the room.`
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
Fix converseJS: show the participant list when not in iframe. 2021-05-02 12:41:54 +00:00			`### Fixes`

			`* Fix converseJS: show the participant list when not in iframe`

Fix Peertube server crash when prosody is not installed. 2021-04-18 15:48:21 +00:00			`## v2.0.3`

			`* Fix Peertube server crash when prosody is not installed`

Changelog update. 2021-04-18 13:02:04 +00:00			`## v2.0.2`

			`* Trying to fix dependencies installation problems`

			`## v2.0.1`

			`* Trying to fix dependencies installation problems`

Documentation. 2021-04-16 15:55:48 +00:00			`## v2.0.0`
Changelog 2021-04-07 16:26:17 +00:00
			`* Code is now in Typescript`
Changelog. 2021-04-16 13:24:59 +00:00			`* Builtin Prosody server, for easy configuration`
			`* Diagnostic tools for helping admins to find misconfigurations`
Changelog 2021-04-07 16:26:17 +00:00
Bump version v1.0.8 2021-04-07 16:23:05 +00:00			`## v1.0.8`
Fix: typo that can prevent settings chat-only-locals to work. 2021-04-07 16:17:17 +00:00
			`* Fix: typo that can prevent settings chat-only-locals to work`

Link to documentation. 2021-03-12 16:34:57 +00:00			`## v1.0.7`
Update documentation (for prosody tutorial). 2021-03-12 16:25:55 +00:00
			`* New tutorial to setup [Prosody on the Peertube server](documentation/tutorials/prosody.md)`
Link to documentation. 2021-03-12 16:34:57 +00:00			`* Add link to documentation in the settings page.`
Update documentation (for prosody tutorial). 2021-03-12 16:25:55 +00:00
Changelog 2021-03-09 09:14:37 +00:00			`## v1.0.6`

			`* New icons by [Porrumentzio](https://github.com/Porrumentzio)`

Fix: changing default value to false for every checkbox settings (Peertube bug in <=3.0.1). 2021-03-08 09:22:41 +00:00			`## v1.0.5`

Update changelog 2021-03-08 10:35:06 +00:00			`* New buttons and logo.`
Fix #63: On some old Peertube installations, there can be usernames with upper-case letters. Adding a toLowerCase() for the XMPP jid. 2021-08-05 09:51:16 +00:00			`* Fix: changing default value to false for every checkbox settings (Peertube bug in <=3.0.1: [https://github.com/Chocobozzz/PeerTube/issues/3838](https://github.com/Chocobozzz/PeerTube/issues/3838)).`
Fix: changing default value to false for every checkbox settings (Peertube bug in <=3.0.1). 2021-03-08 09:22:41 +00:00
v1.0.4 2021-03-01 18:00:39 +00:00			`## v1.0.4`

			`### Features`

			`* Translations for ca, eo, es and eu. Thanks to [Porrumentzio](https://github.com/Porrumentzio).`
			`* UX improvments. Buttons are now icons, and placed on top of the chat container.`

			`### Bug Fixes`

			`* Fix buttons disappearing when lives started of finished.`

ConverseJS fixes and documentation: * using version 7.0.4 * update documentation and example files * disable discover_connection_methods option 2021-02-21 15:10:52 +00:00			`## v1.0.3`

			`### Various changes`

			`* Using converseJS ^7.0.4`
			`* Updating documentation`

Quick fix: add a min-height for the iframe, so that it is not too tiny when under the video. 2021-02-21 01:00:13 +00:00			`## v1.0.2`

			`### Bug fixes`

			`* Quick fix: add a min-height for the iframe, so that it is not too tiny when under the video.`

Fix: When installing the plugin from npm, the node_modules dont come with: copying converseJS to dist folder. 2021-02-21 00:22:07 +00:00			`## v1.0.1`

			`### Bug fixes`

			`* When installing the plugin from npm, the node_modules don't come with: copying converseJS to dist folder.`

			`## v1.0.0`
Look & feel for builtin chat. 2021-02-20 22:29:07 +00:00
			`### Features`

			`* Optional Builtin ConverseJS`
Option for enabling live only on local videos. 2021-02-20 22:37:23 +00:00			`* Option for enabling live only on local videos`
The «open in new window» button is now optional. 2021-02-20 23:13:29 +00:00			`* The «open in new window» button is optional`
Look & feel for builtin chat. 2021-02-20 22:29:07 +00:00
The chat is displayed on the right of the video. 2021-02-20 15:31:16 +00:00			`## v0.0.8`

			`### Features`

			`* The chat is displayed on the right of the video`

Fix uncomplete commit. 2021-02-20 15:03:44 +00:00			`## v0.0.7`

			`### Bug Fixes`

			`* Fix incomplete commit`

Changelog 2021-02-20 13:22:24 +00:00			`## v0.0.6`

Changelog. 2021-02-20 13:28:02 +00:00			`### Features`

			`* Use eslint to lint the code`

Bump to version 0.0.6 2021-02-20 14:45:45 +00:00			`### Bug fixes`
Changelog. 2021-02-20 13:28:02 +00:00
			`* Fix dom positionning`
Fix: * Chat should be displayed for waiting and ended lives * Chat and chat buttons must be cleaned out of the dom on navigation 2021-02-20 14:41:00 +00:00			`* Chat should be displayed for waiting and ended lives`
			`* Chat and chat buttons must be cleaned out of the dom on navigation`
Changelog 2021-02-20 13:22:24 +00:00
			`## v0.0.5`

Changelog. 2021-02-20 13:28:02 +00:00			`* Initial release`