Forrest logo
back to the register_new_matrix_user tool

register_new_matrix_user:tldr:aeae6

register_new_matrix_user: Create an admin user non-interactively (not recommended).
$ register_new_matrix_user --config ${path-to-homeserver-yaml} --user ${username} --password ${password} --admin
try on your machine

The command "register_new_matrix_user" is used to create a new user account on a Matrix homeserver. Here is an explanation of the different parts of the command:

  • "register_new_matrix_user": This is the main command that tells the homeserver to create a new user account.

  • "--config ${path-to-homeserver-yaml}": This flag specifies the path to the homeserver YAML configuration file. The YAML file contains various settings and configurations for the Matrix homeserver.

  • "--user ${username}": This flag is used to set the desired username for the new user. Replace '${username}' with the actual desired username.

  • "--password ${password}": This flag is used to set the password for the new user. Replace '${password}' with the actual desired password.

  • "--admin": Including this flag designates the newly created user as an admin. Admin users typically have additional privileges and access rights on the Matrix homeserver.

The command, when executed with the correct values substituted for ${path-to-homeserver-yaml}, ${username}, and ${password}, will create a new user account on the Matrix homeserver with the specified username and password. If the "--admin" flag is included, the user will also have admin privileges.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the register_new_matrix_user tool