diff options
Diffstat (limited to 'docs/administration/CLI_tasks/user.md')
-rw-r--r-- | docs/administration/CLI_tasks/user.md | 147 |
1 files changed, 114 insertions, 33 deletions
diff --git a/docs/administration/CLI_tasks/user.md b/docs/administration/CLI_tasks/user.md index 96b2d9e6a..da8363131 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 <nickname> <email> [<options>] + +```sh tab="OTP" +./bin/pleroma_ctl user new <email> [<options>] +``` + +```sh tab="From Source" +mix pleroma.user new <email> [<options>] ``` + ### Options - `--name <name>` - the user's display name - `--bio <bio>` - the user's bio @@ -16,84 +22,159 @@ $PREFIX new <nickname> <email> [<options>] - `-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 [<options>] +```sh tab="OTP" + ./bin/pleroma_ctl user invite [<options>] ``` +```sh tab="From Source" +mix pleroma.user invite [<options>] +``` + + ### 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_or_id> ``` +```sh tab="From Source" +mix pleroma.user revoke_invite <token_or_id> +``` + + ## 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> ``` +```sh tab="From Source" +mix pleroma.user sign_out <nickname> +``` + + ## Deactivate or activate a user -```sh -$PREFIX toggle_activated <nickname> +```sh tab="OTP" + ./bin/pleroma_ctl user toggle_activated <nickname> ``` +```sh tab="From Source" +mix pleroma.user toggle_activated <nickname> +``` + + ## Unsubscribe local users from a user and deactivate the user -```sh -$PREFIX unsubscribe NICKNAME +```sh tab="OTP" + ./bin/pleroma_ctl user unsubscribe NICKNAME ``` +```sh tab="From Source" +mix pleroma.user unsubscribe NICKNAME +``` + + ## Unsubscribe local users from an instance and deactivate all accounts on it -```sh -$PREFIX unsubscribe_all_from_instance <instance> +```sh tab="OTP" + ./bin/pleroma_ctl user unsubscribe_all_from_instance <instance> ``` +```sh tab="From Source" +mix pleroma.user unsubscribe_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> +``` + + ## Set the value of the given user's settings -```sh -$PREFIX set <nickname> [<options>] +```sh tab="OTP" + ./bin/pleroma_ctl user set <nickname> [<options>] ``` + +```sh tab="From Source" +mix pleroma.user set <nickname> [<options>] +``` + ### 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> +``` + |