Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
M
Matrix Backend
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
IRC Team
Errbot Development
Matrix Backend
Commits
22a8fba1
Commit
22a8fba1
authored
3 years ago
by
Joseph Walton-Rivers
Browse files
Options
Downloads
Patches
Plain Diff
add readme to explain how it works
parent
7d0d95f7
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
readme.md
+46
-0
46 additions, 0 deletions
readme.md
with
46 additions
and
0 deletions
readme.md
0 → 100644
+
46
−
0
View file @
22a8fba1
# Errbot Matrix Backend
*note:*
This is currently a (functional) work in progress.
## Features
*
Get message from matrix (rooms, private messages)
*
Send messages to matrix (responses) - with markdown support
### Still todo
Most (all) of these are in the library, just need mapping
*
General code tidy up
*
Some missing features for backend API (room methods, user methods)
*
Support for e2e encryption (the matrix library natively supports it)
*
Support for non-text message types (ie, images)
*
Support for reactions
# Known issues
## Strange setup
The bot will exit if you use password authentication (after displaying the token and device id) - you then
need to manually stick these in the config file. Would be better if the bot could cache this in some errbot-y
way.
If the bot doesn't do this, the bot generates a new device on each connection, which quickly becomes madness
on the server-side (100s of devices when developing). By fixing the device ID and token, this doesn't happen.
The configuration file for errbot looks like this:
```
backend = 'matrix'
bot_extra_backend_dir = r'./backends/' # path to backends folder
BOT_IDENTITY = {
'homeserver': 'https://matrix.fgmx.uk',
'username': '@errbot:fossgalaxy.com',
# set these to get the token and device id
'password': '', # not used if token is set
'device': '', # not used if token is set
# once known...
#'device_id': '', # DEVICE ID HERE
#'token': '' # ACCESS TOKEN HERE
}
```
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment