mr
matrix-registration
pypi i matrix-registration
mr

matrix-registration

a token based matrix registration api

by Jona Abdinghoff

0.9.1.post1 (see all)
pypi i matrix-registration
Readme

Build Status Coverage Status Translation status PyPI - Python Version PyPI Matrix

matrix-registration

A simple Python application enabling token-based registration for matrix servers.

You may have, like me, encountered the situation where you want to invite your friends to create an account on your homeserver, but neither want to open up public registration nor create accounts for every individual user yourself. This project aims to solve this problem.

With matrix-registration, you can quickly generate tokens on the fly and share them with your friends to allow them to register on your homeserver.

Setup

Install using pip:

pip3 install matrix-registration

or check the docker guide

First start

To start, execute matrix-registration.

A configuration file should be generated for you on first start.

If this fails...

you can create a configuration for your matrix homeserver by copying config.sample.yaml to your server and editing it:

wget https://raw.githubusercontent.com/ZerataX/matrix-registration/master/config.sample.yaml
cp config.sample.yaml config.yaml
nano config.yaml

Then pass the path to this configuration to the application on startup using --config-path /path/to/config.yaml.

INFO:

  • This only asks you for the most important options. You should definitely take a look at the actual configuration file. The path to the file will be printed by matrix-registration the first time it runs.

Usage

$ matrix-registration -h
Usage: matrix-registration [OPTIONS] COMMAND [ARGS]...

  a token based matrix registration app

Options:
  --config-path TEXT  specifies the config file to be used
  --version           Show the flask version
  -h, --help          Show this message and exit.

Commands:
  generate  generate new token
  serve     start api server
  status    view status or disable

After you've started the API server and generated a token you can register an account either:

  • with a simple post request, e.g.:
curl -X POST \
     -F 'username=test' \
     -F 'password=verysecure' \
     -F 'confirm=verysecure' \
     -F 'token=DoubleWizardSki' \
     http://localhost:5000/register
  • or by visiting http://localhost:5000/register?token=DoubleWizardSki

Further Resources

Nginx reverse-proxy

If you'd like to run matrix-registration behind a reverse-proxy, here is an example nginx setup:

location  ~ ^/(static|register) {
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://localhost:5000;
}

Custom registration page

If you want to write your own registration page, you can take a look at the sample in resources/example.html

The html page looks for the query paramater token and sets the token input field to it's value. this would allow you to directly share links with the token included, e.g.:

https://homeserver.tld/register.html?token=DoubleWizardSki

If you already have a website and want to use your own register page, the wiki describes a more advanced nginx setup.

bot

if you're looking for a bot to interface with matrix-registration and manage your tokens, take a look at:

maubot-invite

Similar projects

For more info check the wiki

Artwork attribution

GitHub Stars

145

LAST COMMIT

1yr ago

MAINTAINERS

1

CONTRIBUTORS

14

OPEN ISSUES

10

OPEN PRs

0
VersionTagPublished
0.9.2.dev2
1yr ago
0.9.2.dev1
1yr ago
1.0.0.dev7
1yr ago
1.0.0.dev6
1yr ago
No alternatives found
No tutorials found
Add a tutorial