From 50b2ca4500161d0acc0124abf6a4b7d586974dd6 Mon Sep 17 00:00:00 2001 From: "J. King" Date: Thu, 11 Feb 2021 11:01:04 -0500 Subject: [PATCH] Document tokens and metadata in the manual --- .../025_Using_The_Arsse/010_Managing_Users.md | 37 ++++++++++++++++++- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/docs/en/025_Using_The_Arsse/010_Managing_Users.md b/docs/en/025_Using_The_Arsse/010_Managing_Users.md index 1562768..53f2da0 100644 --- a/docs/en/025_Using_The_Arsse/010_Managing_Users.md +++ b/docs/en/025_Using_The_Arsse/010_Managing_Users.md @@ -21,7 +21,7 @@ Ji0ivMYqi6gKxQK1MHuE # Setting and changing passwords -Setting's a user's password is practically identical to adding a password: +Setting a user's password is nearly identical to adding a user: ```sh sudo -u www-data php arsse.php user set-pass "user@example.com" "new password" @@ -49,7 +49,40 @@ $ sudo -u www-data php arsse.php user set-pass --fever "jane.doe" YfZJHq4fNTRUKDYhzQdR ``` +## Managing login tokens for Miniflux +[Miniflux](/en/Supported_Protocols/Miniflux) clients may optionally log in using tokens: randomly-generated strings which act as persistent passwords. For now these must be generated using the command-line interface: - +```console +$ sudo -u www-data php arsse.php token create "jane.doe" +xRK0huUE9KHNHf_x_H8JG0oRDo4t_WV44whBtr8Ckf0= +``` + +Multiple tokens may be generated for use with different clients, and descriptive labels can be assigned for later identification: + +```console +$ sudo -u www-data php arsse.php token create "jane.doe" Newsflash +xRK0huUE9KHNHf_x_H8JG0oRDo4t_WV44whBtr8Ckf0= +$ sudo -u www-data php arsse.php token create "jane.doe" Reminiflux +L7asI2X_d-krinGJd1GsiRdFm2o06ZUlgD22H913hK4= +``` + +There are also commands for listing and revoking tokens. Please consult the integrated help for more details. + +# Setting and changing user metadata + +Users may also have various metadata properties set. These largely exist for compatibility with [the Miniflux protocol](/en/Supported_Protocols/Miniflux) and have no significant effect. One exception to this, however, is the `admin` flag, which signals whether the user may perform privileged operations where they exist in the supported protocols. + +The flag may be changed using the following command: + +```sh +sudo -u www-data php arsse.php user set "jane.doe" admin true +``` + +As a shortcut it is also possible to create administrators directly: + +```sh +sudo -u www-data php arsse.php user add "user@example.com" "example password" --admin +``` +Please consult the integrated help for more details on metadata and their effects.