Skip to content

Manage actors

List all available commands

sudo -u mobilizon ./bin/mobilizon_ctl actors
docker-compose exec mobilizon mobilizon_ctl actors
MIX_ENV=prod mix mobilizon.actors

Create a new profile

sudo -u mobilizon ./bin/mobilizon_ctl actors.new [<options>]
docker-compose exec mobilizon mobilizon_ctl actors.new [<options>]
MIX_ENV=prod mix mobilizon.actors.new [<options>]

Options

  • --email/-e - Provide the email for the user you want to attach the profile to. Required.
  • --username/-u - The username for the profile. If --display-name isn't given at the same time, this value will also be used as display name.
  • --display-name/-d - The displayed name for the profile. If --username isn't given at the same time, this value will be transformed to create an acceptable username.
  • --type/-t - The type of actor to create. Defaults to person.

Create a new group

sudo -u mobilizon ./bin/mobilizon_ctl actors.new [<options>]
docker-compose exec mobilizon mobilizon_ctl actors.new [<options>]
MIX_ENV=prod mix mobilizon.actors.new [<options>]

Options

  • --username/-u - The username for the group. If --display-name isn't given at the same time, this value will also be used as display name.
  • --display-name/-d - The displayed name for the group. If --username isn't given at the same time, this value will be transformed to create an acceptable username.
  • --group-admin/-a - The username of the profile that will be the group admin. Required.
  • --type/-t - The type of actor to create. Defaults to person. Set it to group to create a group.

Show an actors details

sudo -u mobilizon ./bin/mobilizon_ctl actors.show <actor_username>
docker-compose exec mobilizon mobilizon_ctl actors.show <actor_username>
MIX_ENV=prod mix mobilizon.actors.show <actor_username>

Where <actor_username> is a local or federated, profile or group, such as myprofile, mygroup, remote_profile@remote_instance.com or mygroup@my_remote_instance.com.

In addition to basic informations, it also tells which user the profile belongs to, if local.

Refresh a remote actor

Can be helpful in case of federation issues.

sudo -u mobilizon ./bin/mobilizon_ctl actors.refresh <federated_group_name>
docker-compose exec mobilizon mobilizon_ctl actors.refresh <federated_group_name>
MIX_ENV=prod mix mobilizon.actors.refresh <federated_group_name>

Where <federated_group_name> is a federated group name like mygroup@my_remote_instance.com.


Last update: July 21, 2021