OS Manuals

/usr/local/bin/register_new_matrix_user

Compat package for upstream Docker image paths

From synapse-compat 1.164.2-r0 (enterprise-packages), captured 2026-11-08 by running register_new_matrix_user --help (exit 0). permalink

usage: register_new_matrix_user [-h] [-u USER] [--exists-ok] [-p PASSWORD |
                                --password-file PASSWORD_FILE] [-t USER_TYPE] [-a | --no-admin]
                                (-c CONFIG | -k SHARED_SECRET)
                                [server_url]

Used to register new users with a given homeserver when registration has been disabled. The
homeserver must be configured with the 'registration_shared_secret' option set.

positional arguments:
  server_url            URL to use to talk to the homeserver. By default, tries to find a suitable
                        URL from the configuration file. Otherwise, defaults to
                        'http://localhost:8008'.

options:
  -h, --help            show this help message and exit
  -u, --user USER       Local part of the new user. Will prompt if omitted.
  --exists-ok           Do not fail if the user already exists. The user account will not be
                        updated.
  -p, --password PASSWORD
                        New password for user. Will prompt for a password if this flag and
                        `--password-file` are both omitted.
  --password-file PASSWORD_FILE
                        File containing the new password for user. If set, will override
                        `--password`.
  -t, --user_type USER_TYPE
                        User type as specified in synapse.api.constants.UserTypes
  -a, --admin           Register new user as an admin. Will prompt if --no-admin is not set
                        either.
  --no-admin            Register new user as a regular user. Will prompt if --admin is not set
                        either.
  -c, --config CONFIG   Path to server config file. Used to read in shared secret.
  -k, --shared-secret SHARED_SECRET
                        Shared secret as defined in server config file.
Options (10)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-u, --user USERLocal part of the new user.help
--exists-okDo not fail if the user already exists.help
-p, --password PASSWORDNew password for user.help
--password-file PASSWORD_FILEFile containing the new password for user.help
-t, --user_type USER_TYPEUser type as specified in synapse.api.constants.UserTypeshelp
-a, --adminRegister new user as an admin.help
--no-adminRegister new user as a regular user.help
-c, --config CONFIGPath to server config file.help
-k, --shared-secret SHARED_SECRETShared secret as defined in server config file.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.