Commit 576b6af8 authored by Thomas Citharel's avatar Thomas Citharel 🏃🏻
Browse files

Merge branch 'add-cli-docs-for-actor-creation' into 'master'

Add docs for CLI actor creation

Closes #5

See merge request !59
parents 0f16b05b f78fb8b0
Pipeline #439269 passed with stage
in 22 seconds
......@@ -16,6 +16,54 @@
MIX_ENV=prod mix mobilizon.actors
```
## Create a new profile
=== "Release"
```bash
sudo -u mobilizon ./bin/mobilizon_ctl actors.new [<options>]
```
=== "Docker"
```bash
docker-compose exec mobilizon mobilizon_ctl actors.new [<options>]
```
=== "Source"
```bash
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
=== "Release"
```bash
sudo -u mobilizon ./bin/mobilizon_ctl actors.new [<options>]
```
=== "Docker"
```bash
docker-compose exec mobilizon mobilizon_ctl actors.new [<options>]
```
=== "Source"
```bash
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
=== "Release"
......
......@@ -37,9 +37,12 @@
### Options
* `--password <password>`/ `-p <password>` - the user's password. If this option is missing, a password will be generated randomly.
* `--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 3rd-party auth provider to log-in this user. Allowed values: `ldap`.
## Show a user's details
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment