1
0

register_new_matrix_user.ronn 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. register_new_matrix_user(1) -- Used to register new users with a given home server when registration has been disabled
  2. ======================================================================================================================
  3. ## SYNOPSIS
  4. `register_new_matrix_user` options...
  5. ## DESCRIPTION
  6. **register_new_matrix_user** registers new users with a given home server when
  7. registration has been disabled. For this to work, the home server must be
  8. configured with the 'registration_shared_secret' option set.
  9. This accepts the user credentials like the username, password, is user an
  10. admin or not and registers the user onto the homeserver database. Also,
  11. a YAML file containing the shared secret can be provided. If not, the
  12. shared secret can be provided via the command line.
  13. By default it assumes the home server URL to be `https://localhost:8448`.
  14. This can be changed via the `server_url` command line option.
  15. ## FILES
  16. A sample YAML file accepted by `register_new_matrix_user` is described below:
  17. registration_shared_secret: "s3cr3t"
  18. ## OPTIONS
  19. * `-u`, `--user`:
  20. Local part of the new user. Will prompt if omitted.
  21. * `-p`, `--password`:
  22. New password for user. Will prompt if omitted. Supplying the password
  23. on the command line is not recommended. Use the STDIN instead.
  24. * `-a`, `--admin`:
  25. Register new user as an admin. Will prompt if omitted.
  26. * `-c`, `--config`:
  27. Path to server config file containing the shared secret.
  28. * `-k`, `--shared-secret`:
  29. Shared secret as defined in server config file. This is an optional
  30. parameter as it can be also supplied via the YAML file.
  31. * `server_url`:
  32. URL of the home server. Defaults to 'https://localhost:8448'.
  33. ## EXAMPLES
  34. $ register_new_matrix_user -u user1 -p p@ssword -a -c config.yaml
  35. ## COPYRIGHT
  36. This man page was written by Rahul De <<rahulde@swecha.net>>
  37. for Debian GNU/Linux distribution.
  38. ## SEE ALSO
  39. synctl(1), synapse_port_db(1), hash_password(1), synapse_review_recent_signups(1)