REGISTER_NEW_MATRIX_USER(1)

🦋 register_new_matrix_user — bestie's guide to adding users when signups are locked 🔒💅

okay so real talk: this is register_new_matrix_user, a manual page from the REGISTER_NEW_MATRIX_USER(1) section, and it's literally the tool you reach for when you need to make new accounts on a home server that has registration turned off. no cap, it's giving "backstage pass" energy. 🎀

---

✨ NAME ✨

register_new_matrix_user — the little tool you use to register new users with a given home server when registration has been disabled. 🫶

---

🌸 SYNOPSIS 🌸

register_new_matrix_user options...

---

💖 DESCRIPTION 💖

so register_new_matrix_user registers new users with a given home server when registration has been disabled. but heads up bestie: for this to work, the home server must be configured with the registration_shared_secret option set. that's the whole vibe check, no secret = no entry. 🔑

it accepts the user credentials — the username, the password, whether the user is an admin or not — and registers that user right onto the homeserver database. slay. 💅

also, you can hand it a YAML file containing the shared secret. if you don't, that's fine too — you can just supply the shared secret via the command line instead. ✨

by default it assumes the home server URL is https://localhost:8448, which is the icon default. you can change that with the server_url command line option. 🌈

---

🍓 FILES 🍓

here's a sample YAML file that register_new_matrix_user accepts, described below for you:

registration_shared_secret: "s3cr3t"

---

👑 OPTIONS 👑

• -u, --user — local part of the new user. will prompt if omitted. 🧚
• -p, --password — new password for the user. will prompt if omitted. > ok so real warning time: supplying the password on the command line is not recommended. use the STDIN instead. 💀
• -a, --admin — register the new user as an admin. will prompt if omitted. 🔥
• -c, --config — path to the server config file containing the shared secret. 🎀
• -k, --shared-secret — the shared secret as defined in the server config file. this is an optional parameter, since it can also be supplied via the YAML file. 🌸
• server_url — URL of the home server. defaults to https://localhost:8448. ⭐

---

💜 EXAMPLES 💜

$ register_new_matrix_user -u user1 -p p@ssword -a -c config.yaml

---

🌟 COPYRIGHT 🌟

this man page was written by Rahul De <mailto:rahulde@swecha.net> for the Debian GNU/Linux distribution. 🫶

---

🦋 SEE ALSO 🦋

synctl(1), synapse_port_db(1), hash_password(1), synapse_review_recent_signups(1)

---

and that's the whole page bestie, ate and left no crumbs 💅✨ — this one's from July 2021, REGISTER_NEW_MATRIX_USER(1), so go forth and register responsibly 🎀👑