From 18d52a49df7df6ff251507ae6aed113e38f2a2a9 Mon Sep 17 00:00:00 2001 From: Paco Hope Date: Sat, 26 Nov 2022 23:21:51 -0500 Subject: [PATCH] added readme with instructions --- server-util/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 server-util/README.md diff --git a/server-util/README.md b/server-util/README.md new file mode 100644 index 0000000..d4b9e79 --- /dev/null +++ b/server-util/README.md @@ -0,0 +1,18 @@ +# make-users.py + +This script must be run via python **on your mastodon server** because it calls the [`tootctl`](https://docs.joinmastodon.org/admin/tootctl/) administration tool. There's lots of stuff you can do with the [Mastodon API](https://docs.joinmastodon.org/api/guidelines/), but creating users like this requires a CLI tool. + +This is a _one-time step_ that you do when you begin to use toota-palooza. You can delete this script after you run it once. + +# Usage + +1. Decide on an email address to use for all your accounts. (See EMAIL ADDRESSES below) +2. Decide how many you want to run +3. Copy this `make-users.py` script to your mastodon server. +4. `cd` to a directory where you can write an output file. You could do it from `/tmp` if you wanted to. +5. Make sure the mastodon `tootctl` binary is in your path, or provide the path as a `--path` argument. + +# Email Addresses + +There will be some emails generated (the toota-palooza system tries to minimise them), and email addresses are needed for logging in. So we generate one email address per test user. You give us a regular email address like this: `person@example.com`. We will generate userIDs that look like this: `tooter_pqda_568`. And we will assign the email address: `person+tooter_pqda_568@example.com` to the `tooter_pqda_568` Mastodon account. For most email services (GMail, Yahoo, Hotmail), this ["plus addressing"](https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/plus-addressing-in-exchange-online) has been an Internet standard for decades. +