diff options
author | lain <lain@soykaf.club> | 2020-08-28 12:17:19 +0000 |
---|---|---|
committer | lain <lain@soykaf.club> | 2020-08-28 12:17:19 +0000 |
commit | 73dd5bdb7dcdf804bdbabcf632671d4de5042ebc (patch) | |
tree | efcb0b8e68f86d067de98a23f40a24c7dab79d2f /docs/administration/CLI_tasks/user.md | |
parent | f891e2b2f1d1daa122b9856e4b660be394d31e34 (diff) | |
parent | b141e35d641e733dffe7bd6a45a5bbcafe586c56 (diff) | |
download | pleroma-2.1.0.tar.gz |
Merge branch 'release/2.1.0' into 'stable'v2.1.0
Release/2.1.0
See merge request pleroma/pleroma!2927
Diffstat (limited to 'docs/administration/CLI_tasks/user.md')
-rw-r--r-- | docs/administration/CLI_tasks/user.md | 291 |
1 files changed, 192 insertions, 99 deletions
diff --git a/docs/administration/CLI_tasks/user.md b/docs/administration/CLI_tasks/user.md index f535dad82..3e7f028ba 100644 --- a/docs/administration/CLI_tasks/user.md +++ b/docs/administration/CLI_tasks/user.md @@ -4,13 +4,17 @@ ## Create a user -```sh tab="OTP" -./bin/pleroma_ctl user new <nickname> <email> [option ...] -``` +=== "OTP" -```sh tab="From Source" -mix pleroma.user new <nickname> <email> [option ...] -``` + ```sh + ./bin/pleroma_ctl user new <nickname> <email> [option ...] + ``` + +=== "From Source" + + ```sh + mix pleroma.user new <nickname> <email> [option ...] + ``` ### Options @@ -22,23 +26,33 @@ mix pleroma.user new <nickname> <email> [option ...] - `-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 -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user list + ``` + +=== "From Source" + + ```sh + mix pleroma.user list + ``` ## Generate an invite link -```sh tab="OTP" - ./bin/pleroma_ctl user invite [option ...] -``` -```sh tab="From Source" -mix pleroma.user invite [option ...] -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user invite [option ...] + ``` + +=== "From Source" + + ```sh + mix pleroma.user invite [option ...] + ``` ### Options @@ -46,103 +60,168 @@ mix pleroma.user invite [option ...] - `--max-use NUMBER` - maximum numbers of token uses ## List generated invites -```sh tab="OTP" - ./bin/pleroma_ctl user invites -``` -```sh tab="From Source" -mix pleroma.user invites -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user invites + ``` + +=== "From Source" + + ```sh + mix pleroma.user invites + ``` ## Revoke invite -```sh tab="OTP" - ./bin/pleroma_ctl user revoke_invite <token_or_id> -``` -```sh tab="From Source" -mix pleroma.user revoke_invite <token_or_id> -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user revoke_invite <token> + ``` + +=== "From Source" + + ```sh + mix pleroma.user revoke_invite <token> + ``` ## Delete a user -```sh tab="OTP" - ./bin/pleroma_ctl user rm <nickname> -``` -```sh tab="From Source" -mix pleroma.user rm <nickname> -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user rm <nickname> + ``` + +=== "From Source" + + ```sh + mix pleroma.user rm <nickname> + ``` ## Delete user's posts and interactions -```sh tab="OTP" - ./bin/pleroma_ctl user delete_activities <nickname> -``` -```sh tab="From Source" -mix pleroma.user delete_activities <nickname> -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user delete_activities <nickname> + ``` + +=== "From Source" + + ```sh + mix pleroma.user delete_activities <nickname> + ``` ## Sign user out from all applications (delete user's OAuth tokens and authorizations) -```sh tab="OTP" - ./bin/pleroma_ctl user sign_out <nickname> -``` -```sh tab="From Source" -mix pleroma.user sign_out <nickname> -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user sign_out <nickname> + ``` + +=== "From Source" + + ```sh + mix pleroma.user sign_out <nickname> + ``` + + +## Deactivate or activate a user + +=== "OTP" + ```sh + ./bin/pleroma_ctl user toggle_activated <nickname> + ``` -## Deactivate or activate a user -```sh tab="OTP" - ./bin/pleroma_ctl user toggle_activated <nickname> -``` +=== "From Source" -```sh tab="From Source" -mix pleroma.user toggle_activated <nickname> -``` + ```sh + mix pleroma.user toggle_activated <nickname> + ``` -## Unsubscribe local users from a user and deactivate the user -```sh tab="OTP" - ./bin/pleroma_ctl user unsubscribe NICKNAME -``` +## Deactivate a user and unsubscribes local users from the user -```sh tab="From Source" -mix pleroma.user unsubscribe NICKNAME -``` +=== "OTP" + ```sh + ./bin/pleroma_ctl user deactivate NICKNAME + ``` -## Unsubscribe local users from an instance and deactivate all accounts on it -```sh tab="OTP" - ./bin/pleroma_ctl user unsubscribe_all_from_instance <instance> -``` +=== "From Source" -```sh tab="From Source" -mix pleroma.user unsubscribe_all_from_instance <instance> -``` + ```sh + mix pleroma.user deactivate NICKNAME + ``` + + +## Deactivate all accounts from an instance and unsubscribe local users on it + +=== "OTP" + + ```sh + ./bin/pleroma_ctl user deactivate_all_from_instance <instance> + ``` + +=== "From Source" + + ```sh + mix pleroma.user deactivate_all_from_instance <instance> + ``` ## Create a password reset link for user -```sh tab="OTP" - ./bin/pleroma_ctl user reset_password <nickname> -``` -```sh tab="From Source" -mix pleroma.user reset_password <nickname> -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user reset_password <nickname> + ``` + +=== "From Source" + + ```sh + mix pleroma.user reset_password <nickname> + ``` + + +## Disable Multi Factor Authentication (MFA/2FA) for a user + +=== "OTP" + + ```sh + ./bin/pleroma_ctl user reset_mfa <nickname> + ``` + +=== "From Source" + + ```sh + mix pleroma.user reset_mfa <nickname> + ``` ## Set the value of the given user's settings -```sh tab="OTP" - ./bin/pleroma_ctl user set <nickname> [option ...] -``` -```sh tab="From Source" -mix pleroma.user set <nickname> [option ...] -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user set <nickname> [option ...] + ``` + +=== "From Source" + + ```sh + mix pleroma.user set <nickname> [option ...] + ``` ### Options - `--locked`/`--no-locked` - whether the user should be locked @@ -150,31 +229,45 @@ mix pleroma.user set <nickname> [option ...] - `--admin`/`--no-admin` - whether the user should be an admin ## Add tags to a user -```sh tab="OTP" - ./bin/pleroma_ctl user tag <nickname> <tags> -``` -```sh tab="From Source" -mix pleroma.user tag <nickname> <tags> -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user tag <nickname> <tags> + ``` + +=== "From Source" + + ```sh + mix pleroma.user tag <nickname> <tags> + ``` ## Delete tags from a user -```sh tab="OTP" - ./bin/pleroma_ctl user untag <nickname> <tags> -``` -```sh tab="From Source" -mix pleroma.user untag <nickname> <tags> -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user untag <nickname> <tags> + ``` + +=== "From Source" + + ```sh + mix pleroma.user untag <nickname> <tags> + ``` ## Toggle confirmation status of the user -```sh tab="OTP" - ./bin/pleroma_ctl user toggle_confirmed <nickname> -``` -```sh tab="From Source" -mix pleroma.user toggle_confirmed <nickname> -``` +=== "OTP" + + ```sh + ./bin/pleroma_ctl user toggle_confirmed <nickname> + ``` + +=== "From Source" + ```sh + mix pleroma.user toggle_confirmed <nickname> + ``` |