mirror of
https://github.com/Skylar-Tech/node-red-contrib-matrix-chat.git
synced 2025-04-20 04:53:06 -06:00
Skylar Sadlier
02826e2769
- Add new node `Get Event` that will give you room data for a corresponding roomId and eventId #117 - Add new node `Fetch Event Relations` that can paginate through events related to another event #119 - README updates
72 lines
3.5 KiB
Markdown
72 lines
3.5 KiB
Markdown
# node-red-contrib-matrix-chat
|
||
[Matrix](https://matrix.org/) chat server client for [Node-RED](https://nodered.org/)
|
||
|
||
***Currently in beta. Please report any issues in our repository to help us reach a stable, well-tested release. Breaking changes may occur before our first stable release, so be sure to check the changelog before updating.***
|
||
|
||
Join our public Matrix room for help: [#node-red-contrib-matrix-chat:skylar.tech](https://app.element.io/#/room/#node-red-contrib-matrix-chat:skylar.tech)
|
||
|
||
### Features
|
||
|
||
Supported functionality in this package includes:
|
||
|
||
- **End-to-end encryption (E2EE)**
|
||
- [Work in progress](#end-to-end-encryption-notes)
|
||
- Alternative: Use [Pantalaimon](https://github.com/matrix-org/pantalaimon) for E2EE key synchronization across sessions
|
||
- **Receive events** from rooms: Messages, reactions, images, audio, locations, files, encrypted or unencrypted
|
||
- **Fetch/modify room state**: Update room settings
|
||
- **Paginate room history**
|
||
- **Send files** (encryption support for files coming soon)
|
||
- **Send/edit messages** (supports plain text and HTML formats)
|
||
- **Send typing notifications**
|
||
- **Delete events** (messages, reactions, etc.)
|
||
- **Decrypt files** in E2EE rooms
|
||
- **React to messages**
|
||
- **Admin tools**:
|
||
- Register users on closed Synapse servers (`registration_shared_secret`)
|
||
- Manage users, including listing, adding, editing, deactivating (Synapse API)
|
||
- Force-add users to rooms
|
||
- **Room management**: Invite, kick, ban, join, create, and leave rooms
|
||
|
||
These features allow you to easily build bots, set up chat relays, or even administrate your Matrix server directly from [Node-RED](https://nodered.org/).
|
||
|
||
### Installing
|
||
|
||
Install through Node-RED's UI by searching for `node-red-contrib-matrix-chat`, or use the following command inside your Node-RED directory:
|
||
|
||
```bash
|
||
npm install node-red-contrib-matrix-chat
|
||
```
|
||
|
||
### Usage
|
||
|
||
Explore our [examples](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme) to see the module in action.
|
||
|
||
#### Extending functionality
|
||
|
||
You're not limited to just the nodes we've created. Enable global access in your Matrix Client to directly interact with the client from function nodes and create custom logic.
|
||
|
||
[View an example here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#use-function-node-to-run-any-command).
|
||
|
||
### End-to-End Encryption Notes
|
||
|
||
- This module doesn't handle encryption key synchronization between devices. It’s recommended to use the bot exclusively in Node-RED to prevent issues with E2EE messages.
|
||
- **Storage:** Keys for E2EE are saved in a folder called `matrix-client-storage` within your Node-RED directory. Back up this folder regularly! If lost, you won’t be able to decrypt messages from E2EE rooms.
|
||
- To move your bot to a different installation, migrate this folder and ensure the old and new clients don't run simultaneously.
|
||
|
||
Interested in helping? Contributions to finalize E2EE support are welcome!
|
||
|
||
### Registering a User
|
||
|
||
This module includes a node to register users using the Synapse secret registration endpoint. It returns both an `access_token` and a `device_id`, perfect for setting up the bot.
|
||
|
||
[See how to register a user here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme).
|
||
|
||
### Other Packages
|
||
|
||
- [node-red-contrib-gamedig](https://www.npmjs.com/package/node-red-contrib-gamedig) - Query game servers from Node-RED.
|
||
|
||
### Contributing
|
||
|
||
We welcome all contributions! Please submit a pull request if you add a feature so the whole community can benefit.
|
||
|
||
**Sharing is caring!** |