diff --git a/doc/source/administrator/rights/auth_token.md b/doc/source/administrator/rights/auth_token.md index 4028aad056f68ca313c65f10aef56ed7891d2cfa..b3b03440d37b757e0a89c2f98b551f144aa94bee 100644 --- a/doc/source/administrator/rights/auth_token.md +++ b/doc/source/administrator/rights/auth_token.md @@ -1,20 +1,20 @@ # Gestion des jetons de connexion -Un jeton de connexion est une manière de permettre un accès à l'application, via le compte de la personne qui posssède le jeton, sans avoir à fournir ses identifiants. +Un jeton de connexion est une manière de permettre un accès à l'application, via le compte de la personne qui possède le jeton, sans avoir à fournir ses identifiants. -L'avatange d'un jeton est qu'il ne donne aucune informations sur l'utilisateur à la personne, et peut être désactivé à tout moment. +L'avatange d'un jeton est qu'il ne donne aucunes informations sur l'utilisateur à la personne, et peut être désactivé à tout moment. ## Utilité Le jeton de connexion permet de faire tout ce que l'utilisateur lié au jeton peut faire, et est au centre de plusieurs fonctionnalités : - Il permet l'utilisation de l'API -- Il permet d'utiliser le mode publique de vMap2, en étant connecté à l'application via cet utilisateur. +- Il permet d'utiliser le mode public de vMap2, en étant connecté à l'application via cet utilisateur. - Il permet d'utiliser les widgets. ## Création -Il est possible de créer un token dans l'interface prévue à cet effet, à l'emplacement "Utilisateurs" > "Jetons de connexion", puis de cliquer sur le bouton "Ajouter" pour un ajouter un nouveau jeton de connexion. +Il est possible de créer un token dans l'interface prévue à cet effet, à l'emplacement "Utilisateurs" > "Jetons de connexion", puis de cliquer sur le bouton "Ajouter" pour ajouter un nouveau jeton de connexion.  @@ -43,20 +43,20 @@ Celui-ci peut ensuite être utilisé dans le reste des routes de l'API, dans le ### Connexion au mode publique Une autre des utilités des jetons est la mise en place du mode publique. -En effet, le mode publique nécessite un jeton de connexion afin de pouvoir connecter l'utilisateur invité à l'application. +En effet, le mode public nécessite un jeton de connexion afin de pouvoir connecter l'utilisateur invité à l'application. Pour ce faire, il suffit de paramétrer deux propriétés, dont une nécessitant le jeton de connexion : ```js { - ... - "public_connect_enabled": false, - "public_connect_token": "", - ... +... +"public_connect_enabled": false, +"public_connect_token": "", +... } ``` -Une fois ces informations mises en place, il est possible d'accéder à l'application sans connection de l'utilisateur. +Une fois ces informations mises en place, il est possible d'accéder à l'application sans connexion de l'utilisateur. ```{figure} ../../images/administrator/rights/auth_token/mode_publique.png :alt: mode_publique @@ -71,17 +71,17 @@ Dans vMap2, il est également possible de créer un widget carte qui permet d'in Pour ce faire, il est absolument nécessaire d'avoir un jeton de connexion existant. -Pour créer un widget, il Faut se rendre dans "Cartes et Couches" > "Cartes". +Pour créer un widget, il faut se rendre dans "Cartes et Couches" > "Cartes".  -Il faut ensuite appuyer sur le crayon au niveau de la carte choisie, puis sur le formulaire +Il faut ensuite appuyer sur le crayon au niveau de la carte choisie, puis sur le formulaire. Une fois sur le formulaire d'édition de la carte, il faut se rendre dans le sous-menu "appel externe" et ajouter un nouvel enregistrement :  -Une fois dans l'interface d'ajout, il suffit de remplir les différentes informations, en choisisant le bon token dans la liste déroulante. +Une fois dans l'interface d'ajout, il suffit de remplir les différentes informations, en choisissant le bon token dans la liste déroulante.  diff --git a/doc/source/administrator/rights/data.md b/doc/source/administrator/rights/data.md index 0a0520142cf1737c37697446c4d9a21aae2bd9cd..5eaa7a6a4ec60c8226584a2e5d140aa06b44485c 100644 --- a/doc/source/administrator/rights/data.md +++ b/doc/source/administrator/rights/data.md @@ -1,12 +1,12 @@ # Les droits portant sur les données -La gestion des droits sur la données est une responsabilité administrateur, sa gestion revient donc à ceux-ci. +La gestion des droits sur la donnée est une responsabilité administrateur, sa gestion revient donc à ceux-ci. ## Introduction -Bien que les privilèges permettent l'accès à certaines fonctionalités de l'application, et les groupes à certaines cartes et modèles d'impression, une autre notion importante à considérer quand à la gestion des droits, est la gestion des droits PostgreSQL. +Bien que les privilèges permettent l'accès à certaines fonctionnalités de l'application, et les groupes à certaines cartes et modèles d'impression, une autre notion importante à considérer quant à la gestion des droits, est la gestion des droits PostgreSQL. -En effet, les droits PostgreSQL permettent à l'administrateur de définir quels sont les droits dont les utilisateurs disposent sur une donnée (une table / vue). +En effet, les droits PostgreSQL permettent à l'administrateur de définir quels sont les droits dont les utilisateurs disposent sur une donnée (une table/vue). Rajouter des droits à ces éléments permet notamment à l’utilisateur final de pouvoir réaliser des actions différentes sur une donnée visualisée dans vMap2 (consultation, saisie, édition ou suppression d’une donnée géographique et attributaire). @@ -16,21 +16,21 @@ Une mauvaise gestion, ou un oubli de ceux-ci pourraient entraîner l'impossibili ```{info} Le tutoriel suivant est illustré avec le client SQL pgadmin. -Le fonctionnement peut différer légerement pour d'autres clients (DBeaver, phpMyAdmin, ...). +Le fonctionnement peut différer légèrement pour d'autres clients (DBeaver, phpMyAdmin, ...). Le principe est que le code SQL reste cependant le même. ``` Pour cet exemple, j'aimerais rajouter le privilège `exploitant_ville` sur ma table `data_demo_vmap`.`f_villes_l93`, afin qu'un utilisateur ayant ce privilège puisse utiliser/mettre à jour/supprimer les données de ma couche `ville` utilisant cette table. ```{note} -Le fonctionnement et la création d'un privilège est expliqué dans la [section suivante](./privilege.md). +Le fonctionnement et la création d'un privilège sont expliqués dans la [section suivante](./privilege.md). ```  -Pour ajouter des droits sur une table, il faut tout d'abbord ouvrir un client SQL. +Pour ajouter des droits sur une table, il faut tout d'abord ouvrir un client SQL. -Il faut ensuite effectuer une connexion à la base de données contenant la structure de vMap. +Il faut ensuite effectuer une connexion à la base de données contenant la structure de vMap2.  diff --git a/doc/source/administrator/rights/group.md b/doc/source/administrator/rights/group.md index 93575897ebe03cc64e1e4fb1f0e6e4f6543a5c1c..50a085652f4fe3ae761b1988e752f86d1a8f0c98 100644 --- a/doc/source/administrator/rights/group.md +++ b/doc/source/administrator/rights/group.md @@ -1,19 +1,19 @@ # Les groupes -Les groupes de vMap sont une fonctionnalité administrateur, la charge de leur gestion revient donc à ceux-ci. +Les groupes de vMap2 sont une fonctionnalité administrateur, la charge de leur gestion revient donc à ceux-ci. ## Principe -Un groupe sur vMap est une manière de grouper des utilisateurs, afin de faciliter leur gestion sur beaucoup d'aspects. +Un groupe sur vMap2 est une manière de grouper des utilisateurs, afin de faciliter leur gestion sur beaucoup d'aspects. ## Utilité -Un groupe dans vMap peut-être, et sont dans certains cas, de manière obligatoire, utilisés dans différentes parties de l'application afin de permettre un accès à certaines ressources de l'application à l'ensemble des membres du groupe. +Un groupe dans vMap2 peut-être, et sont dans certains cas, de manière obligatoire, utilisés dans différentes parties de l'application afin de permettre un accès à certaines ressources de l'application à l'ensemble des membres du groupe. :::{admonition} **Détail de l'utilité des groupes** :class: dropdown important -Les groupes de vMap sont utilisés aux emplacements suivants : +Les groupes de vMap2 sont utilisés aux emplacements suivants : Au niveau des "informations générales" à l'édition d'une carte, afin de permettre l'accès aux cartes  @@ -30,7 +30,7 @@ Il existe actuellement deux manières de créer un groupe dans vMap2 : - Via l'interface de création des groupes - Via l'import de groupes de l'interface AD/LDAP -### Création de groupe via l'interface +### Création de groupes via l'interface Il est possible d'ajouter un nouveau groupe dans l'interface "Utilisateurs" > "Groupes", puis en cliquant sur le bouton "Ajouter" en haut à droite :  @@ -56,17 +56,17 @@ Une fois dans ce menu, il est ensuite possible d'ajouter les groupes dans vMap2 :::{admonition} **Synchronisation des groupes AD/LDAP avec vMap2** :class: dropdown important -Il est possible de synchroniser les groupes avec l'annuaire, dans ce cas un script viendra mettre à jour le lien entre les utilisateurs de ce domaine et ce groupe à interval régulier. +Il est possible de synchroniser les groupes avec l'annuaire, dans ce cas, un script viendra mettre à jour le lien entre les utilisateurs de ce domaine et ce groupe à intervalle régulier. La synchronisation est à configurer dans la [configuration](../configuration/active_directory.md). -Il est ensuite possible d'activer ou désactiver la synchronisation dans le menu du groupe, à noter qu'il est également possible de la faire manuellement via le bouton "Synchroniser". +Il est ensuite possible d'activer ou de désactiver la synchronisation dans le menu du groupe, à noter qu'il est également possible de la faire manuellement via le bouton "Synchroniser".  ::: ```{note} -Le fonctionnement est légérement différent de ce que l'application faisait en version 2019 et antérieur. -Les groupes ne sont plus vérifiés par rapport à l'annuaire systématiquement à chaque fois, les groupes locaux sont toujours utilisés, en revanche il est possible de rafraichir le lien local régulièrement pour suivre les modification faites sur l'annuaire. +Le fonctionnement est légèrement différent de ce que l'application faisait en version 2019 et antérieur. +Les groupes ne sont plus vérifiés par rapport à l'annuaire systématiquement à chaque fois, les groupes locaux sont toujours utilisés, en revanche, il est possible de rafraîchir le lien local régulièrement pour suivre les modifications faites sur l'annuaire. ``` -Les groupes fonctionnent par la suite comme des groupes vMap normaux \ No newline at end of file +Les groupes fonctionnent par la suite comme des groupes vMap2 normaux. \ No newline at end of file diff --git a/doc/source/administrator/rights/index.rst b/doc/source/administrator/rights/index.rst index acc0be5efddfe9b807109441b95f84d4102e3ef3..d948b429ff2363327456de598ed8de57a0f0ff88 100644 --- a/doc/source/administrator/rights/index.rst +++ b/doc/source/administrator/rights/index.rst @@ -3,7 +3,7 @@ Gestions des droits -------------- -Cette section concerne la gestion de l'intégralité des droits de l'application vMap, c'est à dire leur utilité, leur fonctionnement, leur portée, ... +Cette section concerne la gestion de l'intégralité des droits de l'application vMap2, c'est-à-dire leurs utilités, leurs fonctionnements, leurs portées, ... ============================================ diff --git a/doc/source/administrator/rights/privilege.md b/doc/source/administrator/rights/privilege.md index 4d82bcbe18f4063931155eef15ffe5fe7e202fc1..b61e7a1650f593f51072ef955454bdc6fda46f1d 100644 --- a/doc/source/administrator/rights/privilege.md +++ b/doc/source/administrator/rights/privilege.md @@ -6,10 +6,10 @@ Les privilèges sont une notion administrateur, leur gestion revient donc à ceu Les privilèges sont l'essence de l'application, ce sont ceux-ci qui permettent l'accès aux différentes fonctionnalités dans l'application. -Il existe deux types types de privilèges : +Il existe deux types de privilèges : - Les privilèges propres à l'application, ceux-ci ne doivent pas être modifiés, édités, ou supprimés, sous peine d'une impossibilité d'utiliser l'application par la suite. -- Les privilèges créés par l'administrateur de l'application, qui servent souvent à limiter l'accès aux donnés. +- Les privilèges créés par l'administrateur de l'application, qui servent souvent à limiter l'accès aux données. ## Privilèges de vMap @@ -17,7 +17,7 @@ vMap contient une liste de privilèges permettant d'autoriser l'accès à diffé - `vmap_user:` Il s'agit du droit le plus basique pour utiliser vMap, il permet l'accès à la cartographie, ainsi qu'à toutes les fonctionnalités associées à celle-ci (requêteur, filtre, sélection, ...). -- `vmap_admin:` Il permet d'accéder à la partie administration de l'application, c'est à dire l'ajout de couches/flux, la gestion de ceux-ci, la gestion des thèmes, des sources de données, des systèmes de coordonnées et des symboles et polices d'écriture. +- `vmap_admin:` Il permet d'accéder à la partie administration de l'application, c'est-à-dire l'ajout de couches/flux, la gestion de ceux-ci, la gestion des thèmes, des sources de données, des systèmes de coordonnées et des symboles et polices d'écriture. - `vmap_data_manager:` permet à l'utilisateur d'avoir accès au mode "tableau", et ses différentes fonctionnalités, à savoir ajouter, supprimer ou modifier de la donnée. @@ -25,7 +25,7 @@ En plus des privilèges vMap2, certains autres privilèges sont disponibles pour - `vitis_user` : permet de se connecter à l'application et de configurer son utilisateur. -- `vitis_admin` : permet l'accès aux modes pour gérer les utilisateurs, domaines, groupes, jetons de connexions, logs, modèles d'email, interface et configuration de l'application. Il a en charge la gestion des paramètres système et de la configuration de vMap. Il accède également dans le mode API à la documentation relative à l'API de vMap. +- `vitis_admin` : permet l'accès aux modes pour gérer les utilisateurs, domaines, groupes, jetons de connexions, logs, modèles d'email, interface et configuration de l'application. Il a en charge la gestion des paramètres système et de la configuration de vMap2. Il accède également dans le mode API à la documentation relative à l'API de vMap2. - `vitis_shared` : permet de gérer l'arborescence du dossier shared, qui est un dossier partagé entre plusieurs utilisateurs pour partager des ressources. diff --git a/doc/source/administrator/rights/restriction.md b/doc/source/administrator/rights/restriction.md index 3577ee16ed2e48a31cbb9a6ebfe73be6531e3792..d75fa3432e46190573ea6326f83968e320798854 100644 --- a/doc/source/administrator/rights/restriction.md +++ b/doc/source/administrator/rights/restriction.md @@ -2,7 +2,7 @@ Les restrictions sont un principe qui permet à un adminstrateur de restreindre l'accès à un utilisateur, à certaines données uniquement, contre un peu de configuration côté application et base de données. -Ce principe est par exemple très utilisé au niveau des données cadastrale, afin de mettre en place des restrictions communale sur les données cadastrales, en renseignant par exemple le code INSEE d'une ou plusieurs commune, afin que l'utilisateur n'ait accès qu'aux données cadastrales nécessaires à son travail sur l'application. +Ce principe est par exemple très utilisé au niveau des données cadastrales, afin de mettre en place des restrictions communale sur les données cadastrales, en renseignant par exemple le code INSEE d'une ou plusieurs communes, afin que l'utilisateur n'ait accès qu'aux données cadastrales nécessaires à son travail sur l'application. ## Configuration @@ -10,13 +10,13 @@ Pour saisir une restriction, il faut se rendre sur un utilisateur, dans la secti  -Une fois dans l'interface de modifications, dans la section "Droits et restrictions", une section "restrictions" permet de définir les différentes restrictions qui seront appliqués sur les données. +Une fois dans l'interface de modifications, dans la section "Droits et restrictions", une section "restrictions" permet de définir les différentes restrictions qui seront appliquées sur les données.  -La bonne syntaxe pour la chaîne de caractères est un ensemble de chaînes de carctères, séparés par un séparateur (le charactères `|`). +La bonne syntaxe pour la chaîne de caractères est un ensemble de chaînes de caractères, séparés par un séparateur (le caractère `|`). -Par exemple, pour des restrictions communales, la bonne syntaxe serait un ensemble de code INSEE, séparées par le caractère `|`. +Par exemple, pour des restrictions communales, la bonne syntaxe serait un ensemble de code INSEE, séparés par le caractère `|`. ```sql 66106|66125|07324 @@ -28,7 +28,7 @@ Une fois cela fait, la restriction est en place, il reste maintenant à voir le ```{tip} Les restrictions sur les données du cadastre sont déjà appliquées par défaut, étant une structure de données de Veremes. -L'ajout n'est nécessaire que dans le cas ou vous voulez appliquer la restriction à des données autres que le modèle de données du cadastre. +L'ajout n'est nécessaire que dans le cas où vous voudriez appliquer la restriction à des données autres que le modèle de données du cadastre. ``` Maintenant que les restrictions sont mises en place côté utilisateur, il faut également s'assurer que la restriction est appliquée à la table, afin de bien filtrer les données retournées. @@ -51,8 +51,8 @@ Puis il faut ensuite rentrer le code de la vue, en ajoutant le code suivant en t ```sql WHERE [nom de la colonne] ~ similar_escape(( SELECT "user".restriction - FROM s_vitis."user" - WHERE "user".login::name = "current_user"()), NULL::text); +FROM s_vitis."user" +WHERE "user".login::name = "current_user"()), NULL::text); ``` Pour ma vue, le code suivant me permet de filtrer les villes : @@ -60,8 +60,8 @@ Pour ma vue, le code suivant me permet de filtrer les villes : ```sql SELECT * FROM data_demo_vmap.f_villes_93 WHERE f_villes_93.code ~ similar_escape(( SELECT "user".restriction - FROM s_vitis."user" - WHERE "user".login::name = "current_user"()), NULL::text); +FROM s_vitis."user" +WHERE "user".login::name = "current_user"()), NULL::text); ```  @@ -83,6 +83,6 @@ Par défaut, sans restrictions, mon utilisateur a accès à la totalité des Pyr  -Une fois la restriction en place (pour celle-ci, `661316|66210`), seules les communes filtrées sont accesibles à l'utilisateur. +Une fois la restriction en place (pour celle-ci, `661316|66210`), seules les communes filtrées sont accessibles à l'utilisateur. 