home

Welcome to the matrix-registration wiki!

Configuration

The config file can be specified as an argument when starting matrix-registration --config-path /path/to/config.yaml serve The following is a detailed description of the config options including examples. The default config can the found here

• server_location change this!
  The address of your synapse server. Since matrix-registration is in almost all cases on the same machine as the synape server this is most likely http://localhost:8008
• server_name change this!
  the domain of your server e.g. @matrixuser:<server_name>
• registration_shared_secret change this!
  copy this from your synapse homeserver.yaml
• admin_api_shared_secret change this!
  the password that is needed to generate tokens with the api
• base_url
  the path where the registartion page should be e.g. /element for https://example.tld/element/register
• client_redirect
  the url where the client should be redirected to after a successful registration, normally the login page of your preferred web-client
• client_logo
  the path to the logo, that should be displayed while registering e.g. /var/www/matrix/mylogo.png
• db advanced
  the path to your sqlite database
• host
  where the matrix-registration server should host on (normaly this is localhost)
• port
  which port the server should bind to (normaly this is 5000)
• rate_limit
  a list of ratelimits. Read more here
• allow_cors advanced
  wheather to set the CORS header
• ip_logging
  whather to log the ip of users that used the token into the token database
• logging advanced optional
  configuration of the logging module Read more here
• password
  
  • min_length
    the minimum lenght of a coosen password
• username
  
  • validation_regex
    list of regex that have to match for the username to be accepted e.g.
  • invalidation_regex
    list of regex that must not match for the username to be accepted

    validation_regex:
    - ^[a-zA-Z]\.[a-zA-Z]$    #usernames must follow the format @xxxx.xxxxx:<server_name>
    - ^dep                    #AND usernames must start with the phrase dep
    - [1357]                  #AND usernames must contain at least on from 1,3,5 or 7
  
    invalidation_regex:
    - (admin|support)         #usernames must not contain the words admin or support - be aware the badminton is also banned then ;)
    - \d$                     #AND usernames must not end with a digit