diff --git a/docs/administration/CLI tasks/maintenance_ tasks.md b/docs/administration/CLI tasks/maintenance_ tasks.md index 4bee7f466..241b77f11 100644 --- a/docs/administration/CLI tasks/maintenance_ tasks.md +++ b/docs/administration/CLI tasks/maintenance_ tasks.md @@ -30,6 +30,9 @@ mix mobilizon.instance gen [] ### move_participant_stats +!!! tip "Environment" + You need to run these commands with the appropriate environment loaded + Task to move participant stats directly on the `event` table (so there's no need to count event participants each time). This task should **only be run once** when migrating from `v1.0.0-beta.1` to `v1.0.0-beta.2`. @@ -41,6 +44,9 @@ mix mobilizon.move_participant_stats ### setup_search +!!! tip "Environment" + You need to run these commands with the appropriate environment loaded + Task to setup search for existing events. This task should **only be run once** when migrating from `v1.0.0-beta.1` to `v1.0.0-beta.2`. diff --git a/docs/administration/CLI tasks/manage_actors.md b/docs/administration/CLI tasks/manage_actors.md new file mode 100644 index 000000000..2ef74e03b --- /dev/null +++ b/docs/administration/CLI tasks/manage_actors.md @@ -0,0 +1,17 @@ +# Manage actors + +!!! tip "Environment" + You need to run these commands with the appropriate environment loaded + +## List all available commands +```bash +mix mobilizon.actors +``` + +## Show an actors details + +```bash +mix mobilizon.actors.show +``` + +In addition to basic informations, it also tells which user the profile belongs to, if local. \ No newline at end of file diff --git a/docs/administration/CLI tasks/manage_users.md b/docs/administration/CLI tasks/manage_users.md index 89bfb8f4e..c8b83f52c 100644 --- a/docs/administration/CLI tasks/manage_users.md +++ b/docs/administration/CLI tasks/manage_users.md @@ -1,4 +1,56 @@ # Manage users -!!! bug - Not yet existing +!!! tip "Environment" + You need to run these commands with the appropriate environment loaded + + +## List all available commands +```bash +mix mobilizon.users +``` + +## Create a new user + +```bash +mix mobilizon.users.new [] +``` + +### Options + +* `--password `/ `-p ` - the user's password. If this option is missing, a password will be generated randomly. +* `--moderator` - make the user a moderator +* `--admin` - make the user an admin + +## Show an user's details + +Displays if the user has confirmed their email, if they're a moderator or an admin and their profiles. + +```bash +mix mobilizon.users.show +``` + +## Modify an user + +```bash +mix mobilizon.users.modify +``` + +### Options + +* `--email ` - the user's new email +* `--password ` - the user's new password. +* `--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 an user + +```bash +mix mobilizon.users.delete +``` + +### Options + +* `--assume_yes`/`-y` Don't ask for confirmation \ No newline at end of file diff --git a/docs/administration/CLI tasks/relay.md b/docs/administration/CLI tasks/relay.md index 8c63f560c..68ef8b804 100644 --- a/docs/administration/CLI tasks/relay.md +++ b/docs/administration/CLI tasks/relay.md @@ -2,24 +2,27 @@ Manages remote relays +!!! tip "Environment" + You need to run these commands with the appropriate environment loaded + ## Make your instance follow a mobilizon instance ```bash -mix mobilizon.relay follow +mix mobilizon.relay follow ``` Example: ```bash -mix mobilizon.relay follow https://example.org/relay +mix mobilizon.relay follow example.org ``` ## Make your instance unfollow a mobilizon instance ```bash -mix mobilizon.relay unfollow +mix mobilizon.relay unfollow ``` Example: ```bash -mix mobilizon.relay unfollow https://example.org/relay +mix mobilizon.relay unfollow example.org ```