2.8 KiB
Registering users
This documentation page tells you how to create user account on your Matrix server.
Table of contents:
Registering users manually
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
Managing users via a Web UI
To manage users more easily (via a web user-interace), you can install Synapse Admin.
Letting certain users register on your private server
If you'd rather keep your server private (public registration closed, as is the default), and let certain people create accounts by themselves (instead of creating user accounts manually like this), consider installing and making use of matrix-registration.
Enabling public user registration
To open up user registration publicly (usually not recommended), consider using the following configuration:
matrix_synapse_enable_registration: true
and running the installation procedure once again.
If you're opening up registrations publicly like this, you might also wish to configure CAPTCHA protection.
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>