Matrix-Mirrors
/
maubot-invite
mirror of https://github.com/williamkray/maubot-invite.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

clean up readme a bit

This commit is contained in:
William Kray 2022-09-06 14:44:45 -07:00
parent 3307eaf2cd
commit baaad0a52a
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,6 +1,22 @@
this is a simple [maubot](https://github.com/maubot/maubot) plugin which interacts with a [matrix-registration](https://github.com/zeratax/matrix-registration) deployment and generates invite tokens.
this is a simple [maubot](https://github.com/maubot/maubot) plugin which interacts with a
[matrix-registration](https://github.com/zeratax/matrix-registration) deployment and generates invite tokens.
modify the config to point to your matrix-registration url, include your admin secret to authenticate, and ensure that you're in the list of approved users.
NOTICE: this bot depends on Maubot engine and matrix-registration. it does not work with synapse's native registration
tokens. reasons you may still prefer this project:
1. you already have set up maubot
2. you already have set up matrix-registration
3. this bot only requires administrative access to matrix-registration, whereas the ability to generate synapse
registration tokens would require the bot to be a server administrator
if you would prefer to use native synapse registration tokens, please check out
[matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot/), an unrelated but similar project which is
a standalone bot (no maubot engine).
## usage
modify the config to point to your matrix-registration url, include your admin secret to authenticate, and ensure that
you're in the list of approved users.
*please note* that matrix-registration versions BELOW 0.9.0 have different API endpoints, expected date structures, json
arguments, etc. and require the `legacy_mr` value in your config to be set to `True`! If your matrix-registration