+12
fcd7c979df
fcd7c979df
Co-authored-by: Artur <145776561+arturict@users.noreply.github.com> Co-authored-by: arturict <arturict@users.noreply.github.com> Co-authored-by: Thomas <thomas@ajnart.fr> Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com> Co-authored-by: Danura30082 <danura30082+github@gmail.com> Co-authored-by: Kushie <122986913+kushiemoon-dev@users.noreply.github.com> Co-authored-by: ajnart <thomas@ajnart.fr> Co-authored-by: ajnart <thomas@ajnart.dev> Co-authored-by: chenjun <chenjun@foxmail.com> Co-authored-by: Wikibear <wikibear@users.noreply.github.com> Co-authored-by: Bergasha <bergasha@gmail.com> Co-authored-by: leafyelin <43306196+leafyelin@users.noreply.github.com> Co-authored-by: Lucas Araujo <lucas.lra@gmail.com> Co-authored-by: GreenMonito <86085570+GreenMonito@users.noreply.github.com> Co-authored-by: Nerdy-Technician <roffo@nerdy-technician.social> Co-authored-by: Jun <34545896+jcstrong@users.noreply.github.com> Co-authored-by: Edmond Abraham <54119952+gitedmond@users.noreply.github.com> Co-authored-by: thrawnx <tight.bulb9384@fastmail.com> Co-authored-by: Chris <58918656+nordada@users.noreply.github.com> Co-authored-by: yi111 <153097222+Yi-111-a@users.noreply.github.com> Co-authored-by: Yanis <naamaneyanis@gmail.com> Co-authored-by: Wikibear <me@sej.de> Co-authored-by: alessiottavo <93441886+alessiottavo@users.noreply.github.com>
81 lines
2.0 KiB
Plaintext
81 lines
2.0 KiB
Plaintext
# Users
|
|
|
|
<Alert type="info">
|
|
|
|
This guide requires that you understand [how to access the CLI](../).
|
|
|
|
</Alert>
|
|
|
|
Using these commands, you can manage the users from the CLI:
|
|
|
|
```bash
|
|
Group of commands to manage users
|
|
|
|
Usage:
|
|
homarr users [command]
|
|
|
|
Available Commands:
|
|
list List all users (id, username, email)
|
|
delete Delete a user by id or username
|
|
update-password Update the password for a user (credentials provider only)
|
|
|
|
Flags:
|
|
-h, --help help for users
|
|
-v, --version version for homarr-cli
|
|
|
|
Use "homarr users [command] --help" for more information about a command.
|
|
```
|
|
|
|
## List Users
|
|
|
|
- Requires a database connection
|
|
|
|
```bash
|
|
ID Username Email
|
|
yj52ek5cyb6du4bp4osbkjry admin xxxx@example.com
|
|
yj52ek5cyb6du4bp4osbkjry admin xxxx@example.com
|
|
yj52ek5cyb6du4bp4osbkjry admin xxxx@example.com
|
|
yj52ek5cyb6du4bp4osbkjry admin xxxx@example.com
|
|
yj52ek5cyb6du4bp4osbkjry admin xxxx@example.com
|
|
yj52ek5cyb6du4bp4osbkjry admin xxxx@example.com
|
|
```
|
|
|
|
## Delete User
|
|
|
|
- Requires a database connection
|
|
- Requires one parameter: `id` or `username`
|
|
|
|
```bash
|
|
Delete a user by id or username
|
|
|
|
Usage:
|
|
homarr users delete [flags]
|
|
|
|
Flags:
|
|
-i, --id string ID of the user
|
|
-u, --username string Name of the user
|
|
-h, --help help for users delete
|
|
-v, --version version for homarr-cli
|
|
```
|
|
|
|
## Update Password
|
|
|
|
- Updates the password of an user
|
|
- Requires database connection
|
|
- Requires either a username or id
|
|
- Requires a password (which will be encrypted by Homarr)
|
|
|
|
```bash
|
|
Update the password for a user (credentials provider only)
|
|
|
|
Usage:
|
|
homarr users update-password [flags]
|
|
|
|
Flags:
|
|
-i, --id string ID of the user
|
|
-u, --username string Name of the user
|
|
-p, --password New password
|
|
-h, --help help for users update-password
|
|
-v, --version version for homarr-cli
|
|
```
|