node-red-contrib-matrix-cha.../README.md
Skylar Sadlier 8bee386216 - 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
2021-08-23 10:17:08 -06:00

2.0 KiB

node-red-contrib-matrix-chat

Matrix chat server client for Node-RED

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.

Examples

We have examples! Check them out

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:

npm install node-red-contrib-matrix-chat

Usage

Using this package is very straightforward. Examples coming soon!

Other Packages

Contributing

All contributions are welcome! If you do add a feature please do a pull request so that everyone benefits :) Sharing is caring.