2019-07-13 22:19:59 +00:00
|
|
|
==================
|
|
|
|
|
supysonic-cli-user
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
----------------------------------
|
|
|
|
|
Supysonic user management commands
|
|
|
|
|
----------------------------------
|
|
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
:Author: Louis-Philippe Véronneau, Alban Féron
|
|
|
|
|
:Date: 2019, 2021
|
2019-07-13 22:19:59 +00:00
|
|
|
:Manual section: 1
|
|
|
|
|
|
|
|
|
|
Synopsis
|
|
|
|
|
========
|
|
|
|
|
|
2021-11-11 15:47:37 +00:00
|
|
|
| ``supysonic-cli user --help``
|
2021-01-03 15:34:29 +00:00
|
|
|
| ``supysonic-cli user list``
|
|
|
|
|
| ``supysonic-cli user add`` `user` [``--password`` `password`] [``--email`` `email`]
|
|
|
|
|
| ``supysonic-cli user delete`` `user`
|
2021-11-11 15:47:37 +00:00
|
|
|
| ``supysonic-cli user changepass`` `user` [``--password`` `password`]
|
2021-01-03 15:34:29 +00:00
|
|
|
| ``supysonic-cli user setroles`` [``--admin``\|\ ``--noadmin``] [``--jukebox``\|\ ``--nojukebox``] `user`
|
2021-02-07 15:35:55 +00:00
|
|
|
| ``supysonic-cli user rename`` `user` `newname`
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
Description
|
|
|
|
|
===========
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
The ``supysonic-cli user`` subcommand manages users, allowing to list them, add
|
|
|
|
|
a new user, delete an existing user, and change their password or roles.
|
|
|
|
|
|
|
|
|
|
``supysonic-cli user list``
|
|
|
|
|
List all the users.
|
|
|
|
|
|
|
|
|
|
``supysonic-cli user add`` `user` [``--password`` `password`] [``--email`` `email`]
|
|
|
|
|
Add a new user named `user`. Will prompt for a password if it isn't given
|
|
|
|
|
with the ``--password`` option.
|
|
|
|
|
|
|
|
|
|
``supysonic-cli user delete`` `user`
|
|
|
|
|
Delete the user `user`.
|
|
|
|
|
|
2021-11-11 15:47:37 +00:00
|
|
|
``supysonic-cli user changepass`` `user` [``--password`` `password`]
|
2021-01-03 15:34:29 +00:00
|
|
|
Change the password of user `user`. Will prompt for the new password if not
|
|
|
|
|
provided.
|
|
|
|
|
|
|
|
|
|
``supysonic-cli user setroles`` [``--admin``\|\ ``--noadmin``] [``--jukebox``\|\ ``--nojukebox``] `user`
|
|
|
|
|
Give or remove rights to user `user`.
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-02-07 15:35:55 +00:00
|
|
|
``supysonic-cli user rename`` `user` `newname`
|
|
|
|
|
Rename the user `user` to `newname`
|
|
|
|
|
|
2019-07-13 22:19:59 +00:00
|
|
|
Options
|
|
|
|
|
=======
|
|
|
|
|
|
2021-11-11 15:47:37 +00:00
|
|
|
-h, --help
|
|
|
|
|
Shows help and exits. Depending on where this option appears it will either list the
|
|
|
|
|
available commands or display help for a specific command.
|
|
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
-p password, --password password
|
|
|
|
|
Specify the user's password upon creation.
|
|
|
|
|
|
|
|
|
|
-e email, --email email
|
|
|
|
|
Specify the user's email.
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
The next options relate to user roles. They work in pairs, one option granting
|
|
|
|
|
a right while the other revokes it; obviously options of the same pair are
|
|
|
|
|
mutually exclusive. The long options are named with the matching right, prefix
|
|
|
|
|
it with a ``no`` to revoke the right. For short options, the upper case letter
|
|
|
|
|
grants the right while the lower case letter revokes it. Short options might be
|
|
|
|
|
combined into a single one such as ``-aJ`` to both revoke the admin right and
|
|
|
|
|
grant the jukebox one.
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
-A, --admin
|
|
|
|
|
Grant admin rights.
|
2019-10-27 16:07:03 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
-a, --noadmin
|
|
|
|
|
Revoke admin rights.
|
2019-10-27 16:07:03 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
-J, --jukebox
|
|
|
|
|
Grant jukebox rights.
|
2019-10-27 16:07:03 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
-j, --nojukebox
|
|
|
|
|
Revoke jukebox rights.
|
2019-07-13 22:19:59 +00:00
|
|
|
|
|
|
|
|
Examples
|
|
|
|
|
========
|
|
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
To add a new admin user named `MyUserName` having password `MyAwesomePassword`::
|
2019-07-13 22:19:59 +00:00
|
|
|
|
2021-01-03 15:34:29 +00:00
|
|
|
$ supysonic-cli user add MyUserName -p MyAwesomePassword
|
|
|
|
|
$ supysonic-cli user setroles -A MyUserName
|
2019-07-13 22:19:59 +00:00
|
|
|
|
|
|
|
|
See Also
|
|
|
|
|
========
|
|
|
|
|
|
2021-01-17 11:29:37 +00:00
|
|
|
``supysonic-cli``\ (1), ``supysonic-cli-folder``\ (1)
|
