Merge pull request #19 from bakraw/testing

Testing - 2024-05-17 14:26

.gitignore

@@ -1 +1 @@
-
+conf/snmp_config.yml

README.md

@@ -2,7 +2,7 @@
 
 ### Code et fichiers de configuration pour la supervision de routeurs Mikrotik via Grafana, Prometheus, SNMP Exporter.
 
-*src* contient *mikromap-cli* qui permet d'ajouter un nouveau routeur à tous les fichiers nécessaires, et *mikromap-api*, un serveur HTTP qui transmet les informations au panel Geomap de Grafana.
+*src* contient le code source de *mikromap-cli* qui permet d'ajouter un nouveau routeur à tous les fichiers nécessaires, et de *mikromap-api*, un serveur HTTP qui transmet les informations au panel Geomap de Grafana.
 
 *conf* contient les fichiers de configuration utilisés par les composants.
 
@@ -45,7 +45,7 @@ Via WinBox, ces options se trouvent dans *IP* > *SNMP* puis *Communities*.
 
 #### Watchguard
 
-Sur les pare-feux, veiller à ce que le protocole SNMP soit autorisé pour l'IP du serveur de supervision, et configurer la communauté de la même manière que sur les routeurs Mikrotik.
+Sur les pare-feux, veiller à ce que les protocoles SNMP (pour les infos) et ICMP (pour la vérification de l'état sur la carte) soit autorisé pour l'IP du serveur de supervision, et configurer la communauté de la même manière que sur les routeurs Mikrotik.
 
 #### Fichier de configuration SNMP Exporter
 
@@ -68,7 +68,7 @@ Lancer SNMP Exporter:
 Lancer Grafana:
 ```bash
 cd ~/grafana*/bin/
-./grafana server
+./grafana server --config=$HOME/mikrotik-grafana/conf/grafana_config.ini
 ```
 
 Lancer l'API pour la carte:
@@ -99,12 +99,18 @@ Ajouter deux sources de données:
 1. Prometheus (*Prometheus server URL* = ```http://localhost:9090```)
 2. JSON API (*URL* = ```http://localhost:3333```)
 
-> Laisser les noms par défaut (sinon il faudra re-sélectionner les sources partout où elles sont utilisées).
+> N.B.- Laisser les noms par défaut (sinon il faudra re-sélectionner les sources partout où elles sont utilisées).
 
 ![Config data source Prometheus](https://github.com/bakraw/mikrotik-grafana/assets/161661948/cd5f8abe-a194-4a92-9e77-a2ad1b673a86)
 
 Dans la barre latérale: *Dashboards*, puis *New* > *Import* > *Upload dashboard JSON file* , et choisir ```~/mikrotik-grafana/conf/grafana_dashboard.json```. Séléctionner les sources de données précédemment crées.
 
+Dans la barre latérale: *Administration* > *General* > *Default preferences*, sélectionner *Home Dashboard* = ```General/Supervision Mikrotik```.
+
+Créer d'autres utilisateurs si besoin (dans la barre latérale: *Administration* > *Users and access* > *Users* puis *New user*)
+
+> N.B.- Dans la configuration actuelle, tous les utilisateurs ont accès à tous les dashboards du dossier principal, donc éviter d'en créer d'autres. Sinon, les mettre dans des dossiers à accès restreint.
+
 ## Ajout et supression de routeur
 
 ### Ajout
@@ -115,10 +121,14 @@ cd ~/mikrotik-grafana/bin/
 ./mikromap-cli
 ```
 
-Si l'adresse à ajouter correspond à un Watchguard, l'indiquer en ajoutant un *W* sans espace avant l'adresse IP pour éviter des problèmes de compatibilité (ex: ***W**8.8.8.8*)
+- Si l'adresse IP à ajouter correspond à un Watchguard, l'indiquer en ajoutant un *W* sans espace avant l'adresse IP pour éviter des problèmes de compatibilité (ex: ***W**8.8.8.8*)
+
+> N.B.- L'adresse postale entrée n'a pas besoin d'être parfaitement écrite (pas besoin d'accents, tirets, etc.) mais veiller à inclure un minimum d'informations pour que l'API renvoie les bonnes coordonnées (ex: *1 rue leclerc st etienne* suffit à obtenir *1 Rue du Général Leclerc 42100 Saint-Étienne*)
+
+> N.B.- Le nom d'utilisateur Grafana renseigné est comparé à celui renvoyé directement par Grafana, et doit donc **être identique** à celui du compte Grafana associé (pas grave si les majuscules sont différentes), sinon il n'apparaîtra pas sur le dashboard de cet utilisateur. Laisser le champ vide si le routeur ne doit être vu que par l'admin.
 
-> N. B.- L'adresse postale entrée n'a pas besoin d'être parfaitement écrite (pas besoin d'accents, tirets, etc.) mais veiller à inclure un minimum d'informations pour que l'API renvoie les bonnes coordonnées (ex: *1 rue leclerc st etienne* suffit à obtenir *1 Rue du Général Leclerc 42100 Saint-Étienne*)
+### Suppression
 
-### Supression
+Pour supprimer un routeur, utiliser *mikromap-cli* et entrer un nombre négatif de routeurs à ajouter. 
 
-Pour supprimer un routeur, utiliser *mikromap-cli* et entrer un nombre négatif de routeurs à ajouter. Il n'y a besoin que de l'adresse IP pour supprimer un routeur, et le préfixe *W* n'est pas nécessaire pour désigner un Watchguard.
+> N.B.- Il n'y a besoin que de l'adresse IP pour supprimer un routeur, et le préfixe *W* n'est pas nécessaire pour désigner un Watchguard.