Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

token based matrix registration app

Project description

Build Status Coverage Status PyPI - Python Version PyPI Matrix Chat

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.

setup

pip3 install matrix_registration
python -m matrix_registration

INFO: This only asks you for the most important options. You should definitely take a look at the actual configuration file.

To see where the config is stored execute this:

python -m matrix_registration config

nginx reverse-proxy

an example nginx setup:

location  ~ ^/(static|register) {
        proxy_pass http://localhost:5000;
}

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

usage

$ python -m matrix_registration -h
usage: python -m matrix_registration [-h] {api,gen,status,config} ...

a token based matrix registration app

positional arguments:
  {api,gen,status,config}
                        sub-commands. for ex. 'gen -h' for additional help
    api                 start as api
    gen                 generate new token. -o onetime, -e expire date
    status              view status or disable token. -s status, -d disable,
                        -l list
    config              show config location

optional arguments:
  -h, --help            show this help message and exit

after you've started the api server and generated a token you can register an account 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

resources

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

For more info check the wiki

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for matrix-registration, version 0.5.5
Filename, size File type Python version Upload date Hashes
Filename, size matrix_registration-0.5.5-py3-none-any.whl (582.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size matrix-registration-0.5.5.tar.gz (11.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page