node-red-contrib-matrix-cha.../README.md

# node-red-contrib-matrix-chat
Matrix chat server client for [Node-RED](https://nodered.org/)

***Currently we are in beta. We ask that you open any issues you have on our repository to help us reach a stable well tested version. Things may change & break before our first release so check changelog before updating.***

### Features

The following is supported from this package:

- End-to-end encryption supported
- Receive events from a room (messages, reactions, images, and files) whether encrypted or not
- Send Images/Files (sending files to e2ee room doesn't currently encrypt them yet)
- Decrypt files in e2ee rooms
- Send HTML/Plain Text Message/Notice
- React to messages
- Register user's on closed registration Synapse servers using `registration_shared_secret` (Admin Only)
- List out users on a Synapse server (Admin Only)
- Get WhoIs info for a Synapse user (Admin Only)
- Add/Edit Synapse users using the v2 API (requires a pre-existing admin account)
- Deactivate users on Synapse servers (Admin Only)
- Get a user list from a room
- Kick user from room
- Ban user from room
- Join a room
- Create a room
- Invite to a room
- Synapse admin API to force add user to room (requires bot to be in same room already)


Therefore, you can easily build a bot, chat relay, or administrate your Matrix server from within [Node-RED](https://nodered.org/).

### Usage
We have examples! [Check them out](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme)

### Installing

You can either install from within Node-RED by searching for `node-red-contrib-matrix-chat` or run this from within your Node-RED directory:
```bash
npm install node-red-contrib-matrix-chat
```

### End-to-End Encryption Notes
Currently this module has no way of getting encryption keys from other devices on the same account. Therefore it is recommended you use the bot exclusively with Node-RED after it's creation. Failure to do so will lead to your bot being unable to receive messages from e2ee rooms it joined from another client. Shared secret registration makes this super easy since it returns a token and device ID.

This module stores a folder in your Node-RED directory called `matrix-local-storage` and is it vital that you periodically back this up if you are using e2ee. This is where the client stores all the keys necessary to decrypt messages and if lost you will lose access to e2e rooms. If you move your client to another NR install make sure to migrate this folder as well (and do not let both the old and new client run at same time).

Want to contribute? Any help on getting the last pieces of e2ee figured out would be greatly appreciated :)

### Generate user
You will need a user to use this module. Luckily this module comes with a node that allows you to register users to a homeserver using the secret registration endpoint. This is perfect because it returns an `access_token` as well as a `device_id` which is exactly what we need.

[Click here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme) to see how to generate a user using secret registration


### Other Packages

- [node-red-contrib-gamedig](https://www.npmjs.com/package/node-red-contrib-gamedig) - Query game servers from Node-RED!

### Contributing
All contributions are welcome! If you do add a feature please do a pull request so that everyone benefits :)

Sharing is caring!
- New react node for reacting to messages - made input and output nodes more compatible with each other (for relay purposes). - File/Image input nodes can be combined with a File In node now - Remove console.log debug lines - set version to 0.0.3 - send message node updated to handle message formats and types. - Fixed ignore properties on matrix receive node not saving - created basic readme - WIP on node docs 3 years ago			`# node-red-contrib-matrix-chat`
- matrix-receive node updated so that msg.sender is msg.userId instead (for better node chaining). - change all references from msg.roomId to msg.topic to conform to Node-RED standards. - Added node for listing Synapse users server-wide (as long as the caller is an admin) - Events for Room.timeline are now handled by the server-config node and node's that listen for it bind a listener to that instead of the matrix client. - Added kick and ban nodes for kicking/banning from a room - Added node for fetching synapse user list using synapse admin API - Added node for fetching whois data from a user using Matrix admin API - Added node for deactivating users using the Synapse admin API - Can register users using the Synapse admin endpoint v1 (yay legacy) - Can add users using the Synapse admin endpoint v2 - Add more info to the readme. 3 years ago			`Matrix chat server client for [Node-RED](https://nodered.org/)`

			`*Currently we are in beta. We ask that you open any issues you have on our repository to help us reach a stable well tested version. Things may change & break before our first release so check changelog before updating.*`
Initial commit of an alpha version. 3 years ago
- New react node for reacting to messages - made input and output nodes more compatible with each other (for relay purposes). - File/Image input nodes can be combined with a File In node now - Remove console.log debug lines - set version to 0.0.3 - send message node updated to handle message formats and types. - Fixed ignore properties on matrix receive node not saving - created basic readme - WIP on node docs 3 years ago			`### Features`

			`The following is supported from this package:`

- Update version to 0.1.5 - Updated readme - Support for e2ee is here! It's in beta as I am sure there are still things to do (such as adding a node for encrypting files as files currently are not encrypted). - Added nodes for joining a room (and forcing users into a room), creating rooms, decrypting files, and inviting users to a room. - matrix-synapse-register node name changed from "Synapse Register v1" to "Shared Secret Registration" to make it more self explanatory. - matrix-receive node updated so that instead of selecting what events to ignore you select what events to listen on (this way it isn't a BC every time we add another event). - matrix-receive now handles m.emote & m.sticker events - matrix-server-config updated to now include the device ID and a checkbox to flag whether to enable e2ee support or not. - matrix-synapse-create-edit-user.html updated to include link to the API docs' - matrix-synapse-deactivate-user.html updated to include message about alternative way to deactivate users (in a way that is recoverable) - matrix-synapse-register node does not need to display if connected or not since it users an entirely different API anyways - matrix-synapse-users.html updated to include link to API docs 3 years ago			`- End-to-end encryption supported`
			`- Receive events from a room (messages, reactions, images, and files) whether encrypted or not`
			`- Send Images/Files (sending files to e2ee room doesn't currently encrypt them yet)`
			`- Decrypt files in e2ee rooms`
- matrix-receive node updated so that msg.sender is msg.userId instead (for better node chaining). - change all references from msg.roomId to msg.topic to conform to Node-RED standards. - Added node for listing Synapse users server-wide (as long as the caller is an admin) - Events for Room.timeline are now handled by the server-config node and node's that listen for it bind a listener to that instead of the matrix client. - Added kick and ban nodes for kicking/banning from a room - Added node for fetching synapse user list using synapse admin API - Added node for fetching whois data from a user using Matrix admin API - Added node for deactivating users using the Synapse admin API - Can register users using the Synapse admin endpoint v1 (yay legacy) - Can add users using the Synapse admin endpoint v2 - Add more info to the readme. 3 years ago			`- Send HTML/Plain Text Message/Notice`
- New react node for reacting to messages - made input and output nodes more compatible with each other (for relay purposes). - File/Image input nodes can be combined with a File In node now - Remove console.log debug lines - set version to 0.0.3 - send message node updated to handle message formats and types. - Fixed ignore properties on matrix receive node not saving - created basic readme - WIP on node docs 3 years ago			`- React to messages`
- matrix-receive node updated so that msg.sender is msg.userId instead (for better node chaining). - change all references from msg.roomId to msg.topic to conform to Node-RED standards. - Added node for listing Synapse users server-wide (as long as the caller is an admin) - Events for Room.timeline are now handled by the server-config node and node's that listen for it bind a listener to that instead of the matrix client. - Added kick and ban nodes for kicking/banning from a room - Added node for fetching synapse user list using synapse admin API - Added node for fetching whois data from a user using Matrix admin API - Added node for deactivating users using the Synapse admin API - Can register users using the Synapse admin endpoint v1 (yay legacy) - Can add users using the Synapse admin endpoint v2 - Add more info to the readme. 3 years ago			- Register user's on closed registration Synapse servers using `registration_shared_secret` (Admin Only)
			`- List out users on a Synapse server (Admin Only)`
			`- Get WhoIs info for a Synapse user (Admin Only)`
			`- Add/Edit Synapse users using the v2 API (requires a pre-existing admin account)`
- Update version to 0.1.5 - Updated readme - Support for e2ee is here! It's in beta as I am sure there are still things to do (such as adding a node for encrypting files as files currently are not encrypted). - Added nodes for joining a room (and forcing users into a room), creating rooms, decrypting files, and inviting users to a room. - matrix-synapse-register node name changed from "Synapse Register v1" to "Shared Secret Registration" to make it more self explanatory. - matrix-receive node updated so that instead of selecting what events to ignore you select what events to listen on (this way it isn't a BC every time we add another event). - matrix-receive now handles m.emote & m.sticker events - matrix-server-config updated to now include the device ID and a checkbox to flag whether to enable e2ee support or not. - matrix-synapse-create-edit-user.html updated to include link to the API docs' - matrix-synapse-deactivate-user.html updated to include message about alternative way to deactivate users (in a way that is recoverable) - matrix-synapse-register node does not need to display if connected or not since it users an entirely different API anyways - matrix-synapse-users.html updated to include link to API docs 3 years ago			`- Deactivate users on Synapse servers (Admin Only)`
- matrix-receive node updated so that msg.sender is msg.userId instead (for better node chaining). - change all references from msg.roomId to msg.topic to conform to Node-RED standards. - Added node for listing Synapse users server-wide (as long as the caller is an admin) - Events for Room.timeline are now handled by the server-config node and node's that listen for it bind a listener to that instead of the matrix client. - Added kick and ban nodes for kicking/banning from a room - Added node for fetching synapse user list using synapse admin API - Added node for fetching whois data from a user using Matrix admin API - Added node for deactivating users using the Synapse admin API - Can register users using the Synapse admin endpoint v1 (yay legacy) - Can add users using the Synapse admin endpoint v2 - Add more info to the readme. 3 years ago			`- Get a user list from a room`
			`- Kick user from room`
			`- Ban user from room`
- Update version to 0.1.5 - Updated readme - Support for e2ee is here! It's in beta as I am sure there are still things to do (such as adding a node for encrypting files as files currently are not encrypted). - Added nodes for joining a room (and forcing users into a room), creating rooms, decrypting files, and inviting users to a room. - matrix-synapse-register node name changed from "Synapse Register v1" to "Shared Secret Registration" to make it more self explanatory. - matrix-receive node updated so that instead of selecting what events to ignore you select what events to listen on (this way it isn't a BC every time we add another event). - matrix-receive now handles m.emote & m.sticker events - matrix-server-config updated to now include the device ID and a checkbox to flag whether to enable e2ee support or not. - matrix-synapse-create-edit-user.html updated to include link to the API docs' - matrix-synapse-deactivate-user.html updated to include message about alternative way to deactivate users (in a way that is recoverable) - matrix-synapse-register node does not need to display if connected or not since it users an entirely different API anyways - matrix-synapse-users.html updated to include link to API docs 3 years ago			`- Join a room`
			`- Create a room`
			`- Invite to a room`
			`- Synapse admin API to force add user to room (requires bot to be in same room already)`
- matrix-receive node updated so that msg.sender is msg.userId instead (for better node chaining). - change all references from msg.roomId to msg.topic to conform to Node-RED standards. - Added node for listing Synapse users server-wide (as long as the caller is an admin) - Events for Room.timeline are now handled by the server-config node and node's that listen for it bind a listener to that instead of the matrix client. - Added kick and ban nodes for kicking/banning from a room - Added node for fetching synapse user list using synapse admin API - Added node for fetching whois data from a user using Matrix admin API - Added node for deactivating users using the Synapse admin API - Can register users using the Synapse admin endpoint v1 (yay legacy) - Can add users using the Synapse admin endpoint v2 - Add more info to the readme. 3 years ago
- New react node for reacting to messages - made input and output nodes more compatible with each other (for relay purposes). - File/Image input nodes can be combined with a File In node now - Remove console.log debug lines - set version to 0.0.3 - send message node updated to handle message formats and types. - Fixed ignore properties on matrix receive node not saving - created basic readme - WIP on node docs 3 years ago
- matrix-receive node updated so that msg.sender is msg.userId instead (for better node chaining). - change all references from msg.roomId to msg.topic to conform to Node-RED standards. - Added node for listing Synapse users server-wide (as long as the caller is an admin) - Events for Room.timeline are now handled by the server-config node and node's that listen for it bind a listener to that instead of the matrix client. - Added kick and ban nodes for kicking/banning from a room - Added node for fetching synapse user list using synapse admin API - Added node for fetching whois data from a user using Matrix admin API - Added node for deactivating users using the Synapse admin API - Can register users using the Synapse admin endpoint v1 (yay legacy) - Can add users using the Synapse admin endpoint v2 - Add more info to the readme. 3 years ago			`Therefore, you can easily build a bot, chat relay, or administrate your Matrix server from within [Node-RED](https://nodered.org/).`
- New react node for reacting to messages - made input and output nodes more compatible with each other (for relay purposes). - File/Image input nodes can be combined with a File In node now - Remove console.log debug lines - set version to 0.0.3 - send message node updated to handle message formats and types. - Fixed ignore properties on matrix receive node not saving - created basic readme - WIP on node docs 3 years ago
- Fixed not being able to disable e2ee - Session.logged_out events are now processed to display an error from the node (helps user figure out why their login failed). - Update description for matrix-server-config - Updated readme & examples 3 years ago			`### Usage`
			`We have examples! [Check them out](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme)`
Added some examples 3 years ago
- New react node for reacting to messages - made input and output nodes more compatible with each other (for relay purposes). - File/Image input nodes can be combined with a File In node now - Remove console.log debug lines - set version to 0.0.3 - send message node updated to handle message formats and types. - Fixed ignore properties on matrix receive node not saving - created basic readme - WIP on node docs 3 years ago			`### Installing`

			You can either install from within Node-RED by searching for `node-red-contrib-matrix-chat` or run this from within your Node-RED directory:
			```bash
			`npm install node-red-contrib-matrix-chat`
			```

- Fixed not being able to disable e2ee - Session.logged_out events are now processed to display an error from the node (helps user figure out why their login failed). - Update description for matrix-server-config - Updated readme & examples 3 years ago			`### End-to-End Encryption Notes`
			`Currently this module has no way of getting encryption keys from other devices on the same account. Therefore it is recommended you use the bot exclusively with Node-RED after it's creation. Failure to do so will lead to your bot being unable to receive messages from e2ee rooms it joined from another client. Shared secret registration makes this super easy since it returns a token and device ID.`

			This module stores a folder in your Node-RED directory called `matrix-local-storage` and is it vital that you periodically back this up if you are using e2ee. This is where the client stores all the keys necessary to decrypt messages and if lost you will lose access to e2e rooms. If you move your client to another NR install make sure to migrate this folder as well (and do not let both the old and new client run at same time).

			`Want to contribute? Any help on getting the last pieces of e2ee figured out would be greatly appreciated :)`

			`### Generate user`
			You will need a user to use this module. Luckily this module comes with a node that allows you to register users to a homeserver using the secret registration endpoint. This is perfect because it returns an `access_token` as well as a `device_id` which is exactly what we need.

			`[Click here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme) to see how to generate a user using secret registration`

- New react node for reacting to messages - made input and output nodes more compatible with each other (for relay purposes). - File/Image input nodes can be combined with a File In node now - Remove console.log debug lines - set version to 0.0.3 - send message node updated to handle message formats and types. - Fixed ignore properties on matrix receive node not saving - created basic readme - WIP on node docs 3 years ago

			`### Other Packages`

			`- [node-red-contrib-gamedig](https://www.npmjs.com/package/node-red-contrib-gamedig) - Query game servers from Node-RED!`

			`### Contributing`
			`All contributions are welcome! If you do add a feature please do a pull request so that everyone benefits :)`
- Fixed not being able to disable e2ee - Session.logged_out events are now processed to display an error from the node (helps user figure out why their login failed). - Update description for matrix-server-config - Updated readme & examples 3 years ago
			`Sharing is caring!`