Added documentation for commands to manage users and view actors

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel 2019-12-18 15:58:33 +01:00
parent 9485694392
commit d18620c368
No known key found for this signature in database
GPG key ID: A061B9DDE0CA0773
4 changed files with 84 additions and 6 deletions

View file

@ -30,6 +30,9 @@ mix mobilizon.instance gen [<options>]
### move_participant_stats ### 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). 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`. 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 ### setup_search
!!! tip "Environment"
You need to run these commands with the appropriate environment loaded
Task to setup search for existing events. 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`. This task should **only be run once** when migrating from `v1.0.0-beta.1` to `v1.0.0-beta.2`.

View file

@ -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.

View file

@ -1,4 +1,56 @@
# Manage users # Manage users
!!! bug !!! tip "Environment"
Not yet existing 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 <email> [<options>]
```
### Options
* `--password <password>`/ `-p <password>` - 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 <email>
```
## Modify an user
```bash
mix mobilizon.users.modify <email>
```
### Options
* `--email <email>` - the user's new email
* `--password <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 <email>
```
### Options
* `--assume_yes`/`-y` Don't ask for confirmation

View file

@ -2,24 +2,27 @@
Manages remote relays Manages remote relays
!!! tip "Environment"
You need to run these commands with the appropriate environment loaded
## Make your instance follow a mobilizon instance ## Make your instance follow a mobilizon instance
```bash ```bash
mix mobilizon.relay follow <relay_url> mix mobilizon.relay follow <relay_host>
``` ```
Example: Example:
```bash ```bash
mix mobilizon.relay follow https://example.org/relay mix mobilizon.relay follow example.org
``` ```
## Make your instance unfollow a mobilizon instance ## Make your instance unfollow a mobilizon instance
```bash ```bash
mix mobilizon.relay unfollow <relay_url> mix mobilizon.relay unfollow <relay_host>
``` ```
Example: Example:
```bash ```bash
mix mobilizon.relay unfollow https://example.org/relay mix mobilizon.relay unfollow example.org
``` ```