Merge branch 'develop' into 'cleanup/masto_fe-default_settings'

[akkoma] / docs / administration / CLI_tasks / user.md

diff --git a/docs/administration/CLI_tasks/user.md b/docs/administration/CLI_tasks/user.md
index cf120f2c9fb91fc72f727ab2fb9183a2c25cf8b4..3b4c421a7d0871af8b2486e1665e6d9f9b4556a2 100644 (file)
--- a/docs/administration/CLI_tasks/user.md
+++ b/docs/administration/CLI_tasks/user.md
@@ -1,12 +1,18 @@
 # Managing users
 
-Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl user` and in case of source installs it's `mix pleroma.user`.
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Create a user
-```sh
-$PREFIX new <nickname> <email> [<options>]
+
+```sh tab="OTP"
+./bin/pleroma_ctl user new <nickname> <email> [option ...]
+```
+
+```sh tab="From Source"
+mix pleroma.user new <nickname> <email> [option ...]
 ```
 
+
 ### Options
 - `--name <name>` - the user's display name
 - `--bio <bio>` - the user's bio
@@ -15,80 +21,169 @@ $PREFIX new <nickname> <email> [<options>]
 - `--admin`/`--no-admin` - whether the user should be an admin
 - `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions
 
+## List local users
+```sh tab="OTP"
+ ./bin/pleroma_ctl user list
+```
+
+```sh tab="From Source"
+mix pleroma.user list
+```
+
+
 ## Generate an invite link
-```sh
-$PREFIX invite [<options>]
+```sh tab="OTP"
+ ./bin/pleroma_ctl user invite [option ...]
+```
+
+```sh tab="From Source"
+mix pleroma.user invite [option ...]
 ```
 
+
 ### Options
 - `--expires-at DATE` - last day on which token is active (e.g. "2019-04-05")
 - `--max-use NUMBER` - maximum numbers of token uses
 
 ## List generated invites
-```sh
-$PREFIX invites
+```sh tab="OTP"
+ ./bin/pleroma_ctl user invites
+```
+
+```sh tab="From Source"
+mix pleroma.user invites
 ```
 
+
 ## Revoke invite
-```sh
-$PREFIX revoke_invite <token_or_id>
+```sh tab="OTP"
+ ./bin/pleroma_ctl user revoke_invite <token>
+```
+
+```sh tab="From Source"
+mix pleroma.user revoke_invite <token>
 ```
 
+
 ## Delete a user
-```sh
-$PREFIX rm <nickname>
+```sh tab="OTP"
+ ./bin/pleroma_ctl user rm <nickname>
 ```
 
+```sh tab="From Source"
+mix pleroma.user rm <nickname>
+```
+
+
 ## Delete user's posts and interactions
-```sh
-$PREFIX delete_activities <nickname>
+```sh tab="OTP"
+ ./bin/pleroma_ctl user delete_activities <nickname>
 ```
 
+```sh tab="From Source"
+mix pleroma.user delete_activities <nickname>
+```
+
+
 ## Sign user out from all applications (delete user's OAuth tokens and authorizations)
-```sh
-$PREFIX sign_out <nickname>
+```sh tab="OTP"
+ ./bin/pleroma_ctl user sign_out <nickname>
 ```
 
-## Deactivate or activate a user 
-```sh
-$PREFIX toggle_activated <nickname> 
+```sh tab="From Source"
+mix pleroma.user sign_out <nickname>
 ```
 
-## Unsubscribe local users from a user and deactivate the user
-```sh
-$PREFIX unsubscribe NICKNAME
+
+## Deactivate or activate a user
+```sh tab="OTP"
+ ./bin/pleroma_ctl user toggle_activated <nickname>
 ```
 
-## Unsubscribe local users from an instance and deactivate all accounts on it
-```sh
-$PREFIX unsubscribe_all_from_instance <instance>
+```sh tab="From Source"
+mix pleroma.user toggle_activated <nickname>
+```
+
+
+## Deactivate a user and unsubscribes local users from the user
+```sh tab="OTP"
+ ./bin/pleroma_ctl user deactivate NICKNAME
 ```
 
+```sh tab="From Source"
+mix pleroma.user deactivate NICKNAME
+```
+
+
+## Deactivate all accounts from an instance and unsubscribe local users on it
+```sh tab="OTP"
+ ./bin/pleroma_ctl user deactivate_all_from_instance <instance>
+```
+
+```sh tab="From Source"
+mix pleroma.user deactivate_all_from_instance <instance>
+```
+
+
 ## Create a password reset link for user
-```sh
-$PREFIX reset_password <nickname>
+```sh tab="OTP"
+ ./bin/pleroma_ctl user reset_password <nickname>
+```
+
+```sh tab="From Source"
+mix pleroma.user reset_password <nickname>
 ```
 
+
+## Disable Multi Factor Authentication (MFA/2FA) for a user
+```sh tab="OTP"
+ ./bin/pleroma_ctl user reset_mfa <nickname>
+```
+
+```sh tab="From Source"
+mix pleroma.user reset_mfa <nickname>
+```
+
+
 ## Set the value of the given user's settings
-```sh
-$PREFIX set <nickname> [<options>]
+```sh tab="OTP"
+ ./bin/pleroma_ctl user set <nickname> [option ...]
+```
+
+```sh tab="From Source"
+mix pleroma.user set <nickname> [option ...]
 ```
+
 ### Options
 - `--locked`/`--no-locked` - whether the user should be locked
 - `--moderator`/`--no-moderator` - whether the user should be a moderator
 - `--admin`/`--no-admin` - whether the user should be an admin
 
 ## Add tags to a user
-```sh
-$PREFIX tag <nickname> <tags>
+```sh tab="OTP"
+ ./bin/pleroma_ctl user tag <nickname> <tags>
+```
+
+```sh tab="From Source"
+mix pleroma.user tag <nickname> <tags>
 ```
 
+
 ## Delete tags from a user
-```sh
-$PREFIX untag <nickname> <tags>
+```sh tab="OTP"
+ ./bin/pleroma_ctl user untag <nickname> <tags>
+```
+
+```sh tab="From Source"
+mix pleroma.user untag <nickname> <tags>
 ```
 
+
 ## Toggle confirmation status of the user
-```sh
-$PREFIX toggle_confirmed <nickname>
+```sh tab="OTP"
+ ./bin/pleroma_ctl user toggle_confirmed <nickname>
+```
+
+```sh tab="From Source"
+mix pleroma.user toggle_confirmed <nickname>
 ```