X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=docs%2Fadministration%2FCLI_tasks%2Fuser.md;h=3b4c421a7d0871af8b2486e1665e6d9f9b4556a2;hb=e1a1c8e7de5e10fa64d168dc5d35a80b96767395;hp=96b2d9e6a3326fafcd5bf54e0cceeaa88a288bf0;hpb=7722e5a67a46304f3ae0e37f674a44ca9268be5e;p=akkoma diff --git a/docs/administration/CLI_tasks/user.md b/docs/administration/CLI_tasks/user.md index 96b2d9e6a..3b4c421a7 100644 --- 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 [] + +```sh tab="OTP" +./bin/pleroma_ctl user new [option ...] +``` + +```sh tab="From Source" +mix pleroma.user new [option ...] ``` + ### Options - `--name ` - the user's display name - `--bio ` - the user's bio @@ -16,84 +22,168 @@ $PREFIX new [] - `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions ## List local users -```sh -$PREFIX list +```sh tab="OTP" + ./bin/pleroma_ctl user list ``` +```sh tab="From Source" +mix pleroma.user list +``` + + ## Generate an invite link -```sh -$PREFIX invite [] +```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 +```sh tab="OTP" + ./bin/pleroma_ctl user revoke_invite ``` +```sh tab="From Source" +mix pleroma.user revoke_invite +``` + + ## Delete a user -```sh -$PREFIX rm +```sh tab="OTP" + ./bin/pleroma_ctl user rm +``` + +```sh tab="From Source" +mix pleroma.user rm ``` + ## Delete user's posts and interactions -```sh -$PREFIX delete_activities +```sh tab="OTP" + ./bin/pleroma_ctl user delete_activities +``` + +```sh tab="From Source" +mix pleroma.user delete_activities ``` + ## Sign user out from all applications (delete user's OAuth tokens and authorizations) -```sh -$PREFIX sign_out +```sh tab="OTP" + ./bin/pleroma_ctl user sign_out +``` + +```sh tab="From Source" +mix pleroma.user sign_out ``` -## Deactivate or activate a user -```sh -$PREFIX toggle_activated + +## Deactivate or activate a user +```sh tab="OTP" + ./bin/pleroma_ctl user toggle_activated ``` -## Unsubscribe local users from a user and deactivate the user -```sh -$PREFIX unsubscribe NICKNAME +```sh tab="From Source" +mix pleroma.user toggle_activated ``` -## Unsubscribe local users from an instance and deactivate all accounts on it -```sh -$PREFIX unsubscribe_all_from_instance + +## 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 +``` + +```sh tab="From Source" +mix pleroma.user deactivate_all_from_instance +``` + + ## Create a password reset link for user -```sh -$PREFIX reset_password +```sh tab="OTP" + ./bin/pleroma_ctl user reset_password +``` + +```sh tab="From Source" +mix pleroma.user reset_password +``` + + +## Disable Multi Factor Authentication (MFA/2FA) for a user +```sh tab="OTP" + ./bin/pleroma_ctl user reset_mfa +``` + +```sh tab="From Source" +mix pleroma.user reset_mfa ``` + ## Set the value of the given user's settings -```sh -$PREFIX set [] +```sh tab="OTP" + ./bin/pleroma_ctl user set [option ...] +``` + +```sh tab="From Source" +mix pleroma.user set [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 +```sh tab="OTP" + ./bin/pleroma_ctl user tag +``` + +```sh tab="From Source" +mix pleroma.user tag ``` + ## Delete tags from a user -```sh -$PREFIX untag +```sh tab="OTP" + ./bin/pleroma_ctl user untag +``` + +```sh tab="From Source" +mix pleroma.user untag ``` + ## Toggle confirmation status of the user -```sh -$PREFIX toggle_confirmed +```sh tab="OTP" + ./bin/pleroma_ctl user toggle_confirmed +``` + +```sh tab="From Source" +mix pleroma.user toggle_confirmed ```