matrix-docker-ansible-deploy/docs/registering-users.md
Slavi Pantaleev b2ae669566 Add synapse-admin support
Fixes #562 (Github Issue)
2020-07-22 08:10:26 +03:00

1.5 KiB

Registering users

Run this to create a new user account on your Matrix server.

You can do it via this Ansible playbook (make sure to edit the <your-username> and <your-password> part below):

ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=<your-username> password=<your-password> admin=<yes|no>' --tags=register-user

or using the command-line after SSH-ing to your server (requires that all services have been started):

/usr/local/bin/matrix-synapse-register-user <your-username> <your-password> <admin access: 0 or 1>

Note: <your-username> is just a plain username (like john), not your full @<username>:<your-domain> identifier.

You can then log in with that user via the Element service that this playbook has created for you at a URL like this: https://element.<domain>/.


If you've just installed Matrix, to finalize the installation process, it's best if you proceed to Configuring service discovery via .well-known


Adding/Removing Administrator privileges to an existing user.

The script /usr/local/bin/matrix-change-user-admin-status may be used to change a user's admin privileges.

  • log on to your server with ssh
  • execute with the username and 0/1 (0 = non-admin | 1 = admin)
/usr/local/bin/matrix-change-user-admin-status <username> <0/1>

Managing users via a Web UI

To manage users more easily (via a web user-interace), you can install Synapse Admin.