matrix-registration

A simple python application to have a token based matrix registration

If you like me encountered the situation where you want to invite your friends to your homeserver, but neither wanted to open up public registration nor create accounts for every individual user yourself, this project should be the solution.

With this project you can just quickly generate tokens on the fly and share them with your friends to allow them to register to your homeserver.

Example Usage

• Create a new one time usable token directly with python:

  $ matrix-registration generate -e 2020-12-04
  ColorWhiskeyExpand
  

• or make use of the api:

  $ curl -X POST \
     -H "Authorization: SharedSecret demopagesecret" \
     -H "Content-Type: application/json" \
     -d '{"expiration_date": "2021-12-04"}' \
     https://dmnd.sh/test/api/token
  {"active":true,"disabled":false,"expiration_date":"Fri, 04 Dec 2020 00:00:00 GMT","name":"ColorWhiskeyExpand","max_usage":0,"used":0,ips:[]}
  

• now you can share an invite link to your registration page, with your friends: https://dmnd.sh/test/register?token=ColorWhiskeyExpand

Demo/Dev version

To try the project out you can play around with the demo page for an implemented example registration page using the demo api or

perform a cURL against the demo api, e.g.:

$ curl -H "Authorization: SharedSecret demopagesecret" \
       -H "Content-Type: application/json" \
       -d '{"one_time": true, "ex_date": "24.12.2020"}' \
       https://dmnd.sh/test/api/token

Support or Contact

Having trouble with the application? Check out the wiki page or join #matrix-registration:dmnd.sh and we’ll help you sort it out.