[enh] Add tabs

This commit is contained in:
ljf 2021-07-15 02:24:55 +02:00 committed by ljf (zamentur)
parent 5f12cc894f
commit 77ef32be13
2 changed files with 105 additions and 11 deletions

View file

@ -27,10 +27,14 @@ Par défaut, deux groupes spéciaux sont créés :
Vous ne pouvez pas changer le contenu de ces groupes, seulement les permissions qui leur sont accordées.
### Lister les groupes existants
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="À partir de l'interface web"]
Les groupes existants sont listés en haut de la page *groupes et autorisations*.
![](image://groups_default-groups.png)
[/ui-tab]
[ui-tab title="À partir de la ligne de commande"]
Pour obtenir la liste des groupes existants en CLI :
@ -44,19 +48,29 @@ groups:
- charlie
- delphine
```
[/ui-tab]
[/ui-tabs]
### Créer un nouveau groupe
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="À partir de l'interface web"]
Pour créer un nouveau groupe, il suffit de cliquer sur le bouton "Nouveau groupe" en haut de la page. Vous ne pouvez choisir qu'un nom formé de lettres (majuscules et minuscules) et d'espaces. Le groupe est créé vide et sans aucune permission.
![](image://groups_button-new-group.png)
[/ui-tab]
[ui-tab title="À partir de la ligne de commande"]
Dans la CLI, pour créer un nouveau groupe appelé `yolo_crew`, il faut utiliser
```shell
$ yunohost user group create yolo_crew
```
[/ui-tab]
[/ui-tabs]
### Mettre à jour un groupe
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="À partir de l'interface web"]
Ajoutons un premier utilisateur à ce groupe : dans le panneau du groupe, cliquez sur le bouton "ajouter un utilisateur" et faites défiler jusqu'à l'utilisateur souhaité, puis cliquez dessus.
![](image://groups_button-add-user.png)
@ -65,6 +79,8 @@ Pour supprimer un utilisateur, cliquez sur la croix à côté de son nom d'utili
![](image://groups_button-remove-user.png)
[/ui-tab]
[ui-tab title="À partir de la ligne de commande"]
En CLI, utilisez la commande suivante pour ajouter `charlie` et `delphine` au groupe `yolo_crew` :
```shell
@ -89,18 +105,27 @@ groups:
- charlie
- delphine
```
[/ui-tab]
[/ui-tabs]
### Supprimer un groupe
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="À partir de l'interface web"]
Pour supprimer un groupe, cliquez sur la croix rouge en haut à droite du panneau du groupes. Une confirmation vous sera demandée.
![](image://groups_button-delete-group.png)
[/ui-tab]
[ui-tab title="À partir de la ligne de commande"]
Pour supprimer le groupe `yolo_crew` dans CLI, vous pouvez exécuter
```shell
$ yunohost user group delete yolo_crew
```
[/ui-tab]
[/ui-tabs]
## Gestion des permissions
@ -108,10 +133,14 @@ Le mécanisme de permissions permet de restreindre l'accès aux services (par ex
### Liste des permissions
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="À partir de l'interface web"]
La page des groupes liste les permissions données à chaque groupe, y compris les groupes spéciaux `all_users` et `visitors`.
![](image://groups_default-with-permissions.png)
[/ui-tab]
[ui-tab title="À partir de la ligne de commande"]
Pour répertorier les permissions et les accès correspondants en CLI :
```shell
$ yunohost user permission list
@ -128,13 +157,22 @@ permissions:
Ici, nous constatons que tous les utilisateurs enregistrés peuvent utiliser le courrier électronique, XMPP, et accéder au blog WordPress. Cependant, personne ne peut accéder à l'interface d'administration de WordPress.
Plus de détails peuvent être affichés en ajoutant l'option `--full` qui affichera la liste des utilisateurs correspondant aux groupes autorisés, ainsi que les urls associées à une permission (pertinent pour les applications web).
[/ui-tab]
[/ui-tabs]
### Ajouter des permissions à un groupe ou un utilisateur
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="À partir de l'interface web"]
Pour ajouter une permission à un groupe, il suffit de cliquer sur le bouton "+" dans le panneau du groupe, de faire défiler jusqu'à la permission souhaitée, puis de cliquer dessus.
![](image://groups_add-permission-group.png)
Notez que vous pouvez également autoriser un seul utilisateur, en utilisant le panneau spécifique en bas de la page.
![](image://groups_add-permission-user.png)
[/ui-tab]
[ui-tab title="À partir de la ligne de commande"]
Pour permettre à un groupe d'accéder à l'interface d'administration de WordPress via la CLI :
```shell
@ -143,10 +181,6 @@ $ yunohost user permission update wordpress.admin --add yolo_crew
Notez que vous pouvez également autoriser un seul utilisateur, en utilisant le panneau spécifique en bas de la page.
![](image://groups_add-permission-user.png)
ou en CLI :
```shell
$ yunohost user permission update wordpress.admin --add alice
```
@ -171,6 +205,8 @@ de la permission, en la supprimant du panneau de groupe `all_users`, ou en CLI :
$ yunohost user permission update mail --remove all_users --add bob
```
[/ui-tab]
[/ui-tabs]
Notez que certaines permissions peuvent être "protégées", ce qui signifie que vous ne pourrez pas l'ajouter/enlever du groupe visiteur. Ce mécanisme est généralement là car ajouter/enlever la permission au groupe utilisateur n'a pas de sens (ou est un risque de sécurité).
La webadmin émettra un avertissement si vous définissez une permission qui est remplacée par une permission plus large.
@ -179,9 +215,21 @@ La webadmin émettra un avertissement si vous définissez une permission qui est
### Montrer/cacher les tuiles dans le portail utilisateur
Depuis YunoHost 4.1, il est possible de montrer/cacher certaines tuiles dans le portail. Depuis la webadmin, vous pouvez changer cela en allant dans la vue de l'application à manipuler, puis dans "Gérer les étiquettes et les tuiles", et cocher/décocher l'option "Montrer la tuile dans le portail utilisateur" pour la permission correspondante. En ligne de commande, le même genre de chose peut être fait avec :
Depuis YunoHost 4.1, il est possible de montrer/cacher certaines tuiles dans le portail.
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="À partir de l'interface web"]
Depuis la webadmin, vous pouvez changer cela en allant dans la vue de l'application à manipuler, puis dans `Gérer les étiquettes et les tuiles`, et cocher/décocher l'option `Montrer la tuile dans le portail utilisateur` pour la permission correspondante.
[/ui-tab]
[ui-tab title="À partir de la ligne de commande"]
En ligne de commande, le même genre de chose peut être fait avec :
```shell
# Activer la tuile pour l'interface d'admin de WordPress
$ yunohost user permission update wordpress.admin --show_tile True
```
[/ui-tab]
[/ui-tabs]

View file

@ -28,10 +28,15 @@ The content of those groups cannot be changed, only the permissions given to the
### List existing groups
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="From the web interface"]
The existing groups are listed at the top of the *groups and permissions* page.
![](image://groups_default-groups.png)
[/ui-tab]
[ui-tab title="From the command line"]
To list the currently existing groups in CLI :
```shell
@ -44,22 +49,31 @@ groups:
- charlie
- delphine
```
[/ui-tab]
[/ui-tabs]
### Creating a new group
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="From the web interface"]
To create a new group, simply click on the "New Group" button at the top of the page. You may only choose a name formed with letters (uper- and lowercase) and spaces. The group is created empty and without any permission.
![](image://groups_button-new-group.png)
[/ui-tab]
[ui-tab title="From the command line"]
In CLI, to create a new group called `yolo_crew`
```shell
$ yunohost user group create yolo_crew
```
[/ui-tab]
[/ui-tabs]
### Updating a group
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="From the web interface"]
Let's add a first to this group: in the group panel, click the button "add a user" and scroll to the desired user, then click on it.
![](image://groups_button-add-user.png)
@ -68,6 +82,8 @@ To remove a user, click on the cross next to their username, in the group panel.
![](image://groups_button-remove-user.png)
[/ui-tab]
[ui-tab title="From the command line"]
In CLI, use the following command to add `charlie` and `delphine`to the `yolo_crew` group:
```shell
@ -92,18 +108,26 @@ groups:
- charlie
- delphine
```
[/ui-tab]
[/ui-tabs]
### Deleting groups
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="From the web interface"]
To delete a group, click on the red cross on the top right of the group panel. You will be asked for confirmation.
![](image://groups_button-delete-group.png)
[/ui-tab]
[ui-tab title="From the command line"]
To delete the group `yolo_crew` in CLI, you may run
```shell
$ yunohost user group delete yolo_crew
```
[/ui-tab]
[/ui-tabs]
## Managing permissions
@ -111,10 +135,14 @@ The permission mechanism allow to restrict access to services (for example mail,
### List permissions
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="From the web interface"]
The groups page lists the permissions given to each group, including the special groups `all_users` and `visitors`.
![](image://groups_default-with-permissions.png)
[/ui-tab]
[ui-tab title="From the command line"]
To list permissions and corresponding accesses in CLI:
```shell
@ -133,13 +161,23 @@ permissions:
Here, we find that all registered users can use email, XMPP, and access the WordPress blog. However, nobody can access the WordPress admin interface.
More details can be displayed by adding the `--full` option which will display the list of users corresponding to groups allowed, as well as urls associated to a permission (relevant for web apps).
[/ui-tab]
[/ui-tabs]
### Add accesses to group or users
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="From the web interface"]
To add a permission to a group, simply click the "+" button in the group panel, scroll to the desired permission, then click on it.
![](image://groups_add-permission-group.png)
Note that you can also allow a single user, by using the specific panel at the bottom of the page.
![](image://groups_add-permission-user.png)
[/ui-tab]
[ui-tab title="From the command line"]
To allow a group to access the WordPress admin interface in CLI:
```shell
@ -148,10 +186,6 @@ $ yunohost user permission update wordpress.admin --add yolo_crew
Note that you can also allow a single user, by using the specific panel at the bottom of the page.
![](image://groups_add-permission-user.png)
or in CLI:
```shell
$ yunohost user permission update wordpress.admin --add alice
```
@ -173,6 +207,8 @@ Note that, for example, if we want to restrict permission for email so that only
```shell
$ yunohost user permission update mail --remove all_users --add bob
```
[/ui-tab]
[/ui-tabs]
Note that some permissions may be "protected", meaning that you won't be able to add/remove the visitor group to this permission. Generally, this is because it would make no sense (or is a security risk) to do so.
@ -182,9 +218,19 @@ The webadmin will issue a warning if you set a permission that is superseded by
### Hide/display specific tiles in the user portal
Since YunoHost 4.1, you can choose to hide/display specific tiles in the SSO. In the webadmin, you can do so by going in the corresponding app view, go in "Manage label and tiles" and check/uncheck the option "Display the tile in the user portal" for the corresponding permission. In command line, this may be done with:
Since YunoHost 4.1, you can choose to hide/display specific tiles in the SSO.
[ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="From the web interface"]
In the webadmin, you can do so by going in the corresponding app view, go in `Manage label and tiles` and check/uncheck the option `Display the tile in the user portal` for the corresponding permission.
[/ui-tab]
[ui-tab title="From the command line"]
In command line, this may be done with:
```shell
# Enable the tile for the WordPress admin interface
$ yunohost user permission update wordpress.admin --show_tile True
```
[/ui-tab]
[/ui-tabs]