Manage users¶

List all available commands¶

sudo -u mobilizon ./bin/mobilizon_ctl users

docker compose exec mobilizon mobilizon_ctl users

MIX_ENV=prod mix mobilizon.users

Create a new user¶

sudo -u mobilizon ./bin/mobilizon_ctl users.new <email> [<options>]

docker compose exec mobilizon mobilizon_ctl users.new <email> [<options>]

MIX_ENV=prod mix mobilizon.users.new <email> [<options>]

Options¶

• --password <password>/ -p <password> - the user's password. If this option is missing, a password will be generated randomly, unless --provider is used.
• --moderator - make the user a moderator
• --admin - make the user an admin
• --profile-username - provide an username to create a first profile for this user at the same time. If --profile-display-name isn't given at the same time, this value will also be used as display name.
• --profile-display-name - provide a name to create a first profile for this user at the same time. If --profile-username isn't given at the same time, this value will be transformed to create an acceptable username.
• --provider - specify a 3^rd-party auth provider to log-in this user. Allowed values: ldap.

Show a user's details¶

Displays if the user has confirmed their email, if they're a moderator or an admin and their profiles.

sudo -u mobilizon ./bin/mobilizon_ctl users.show <email>

docker compose exec mobilizon mobilizon_ctl users.show <email>

MIX_ENV=prod mix mobilizon.users.show <email>

Modify a user¶

sudo -u mobilizon ./bin/mobilizon_ctl users.modify <email> [<options>]

docker compose exec mobilizon mobilizon_ctl users.modify <email> [<options>]

MIX_ENV=prod mix mobilizon.users.modify <email> [<options>]

Options¶

• --email <email> - the user's new email
• --password <password> - the user's new password (at least 6 characters with the default configuration)
• --user - make the user a regular user
• --moderator - make the user a moderator
• --admin - make the user an admin
• --enable - enable the user
• --disable - disable the user

Delete a user¶

Deletes a Mobilizon user or multiple users matching a pattern.

sudo -u mobilizon ./bin/mobilizon_ctl users.delete <email|pattern> [<options>]

docker compose exec mobilizon mobilizon_ctl users.delete <email|pattern> [<options>]

MIX_ENV=prod mix mobilizon.users.delete <email|pattern> [<options>]

Options¶

• --assume-yes/-y Don't ask for confirmation
• --all-matching-email-domain Delete all users matching the email domain given as pattern
• --all-matching-ip Delete all users matching the IP given as pattern
• --include-groups-where-admin In addition to the user account and their profiles, delete the groups for which this user is a admin of as well
• --help/-h Display help

Clean unconfirmed users¶

Manually run the cleaning of unconfirmed users (and their profiles).

sudo -u mobilizon ./bin/mobilizon_ctl users.clean [<options>]

docker compose exec mobilizon mobilizon_ctl users.clean [<options>]

MIX_ENV=prod mix mobilizon.users.clean [<options>]

Options¶

• -v, --verbose List the users that were deleted. Implied when using --dry-run.
• -d, --days The number of days after which an unconfirmed user is selected to be deleted
• --dry-run Run the task, but don't delete users, just list them. Implies --verbose.