Commit 8ff2be91 authored by Sébastien RENOU's avatar Sébastien RENOU

Update README.md

parent 86e039aa
# NIV'EAUX, partage d'informations sur les niveaux d'eau
# Niv'Eaux, partage d'informations sur les niveaux d'eau
Créé en 2016 par l'EPTB de la Sèvre Nantaise, cet outil web collaboratif centralise les données utiles pour le suivi des niveaux d’eau en cas de crue. La collecte des données disponibles sur internet (vigicrues, pluviomètres...) est réalisé automatiquement par le biais de tâches planifiées. Ces données peuvent être complétées par des relevés locaux effectués par les utilisateurs de NIVEAUX et saisies directement dans l'outil.
Les utilisateurs peuvent paramétrer des notifications à déclencher sur la station et la hauteur souhaitées. En cas de dépassement de hauteur, une notification leur est automatiquement transmise par SMS ou mail.
......@@ -9,37 +9,41 @@ Les utilisateurs peuvent paramétrer des notifications à déclencher sur la sta
* PostGRE: 9.6
* PostGIS: 2.4
L'outil utilise l'API OVH pour l'envoi de SMS, à modifier si utilisation d'un autre service.
L'outil utilise l'API OVH pour l'envoi de SMS, à modifier si vous utilisez un autre service.
Lors de l'installation il faudra paramétrer une tâche CRON sur le serveur pour automatiser les relevés.
## Installation
### Récupération du code et dépôt sur le serveur
Téléchargez la dernière version du code : http://gitlab.sevre-nantaise.com/eptbsn-foss/niveaux/repository/master/archive.zip
Téléchargez la dernière version du code : http://gitlab.sevre-nantaise.com/eptbsn/niveaux-foss/repository/master/archive.zip
Dézippez les fichiers sur votre serveur web
Utilisez *composer* pour charger les dépendances :
* Téléchargez *composer* : https://getcomposer.org/
* Déposez composer.phar à la racine de votre projet
* Déposez composer.phar à la racine de votre projet, au même emplacement que *composer.json*
* Exécutez
```sh
$ php composer.phar install
```
* *composer* va télécharger les dépendances dans /vendor
### Création de la base de données
Créez une base de données (ou utilisez en une existante, dans ce cas assurez vous qu'un schéma *niveaux* n'existe pas déjà)
Créez une base de données (ou utilisez en une existante, dans ce cas assurez vous qu'un schéma *niveaux* n'existe pas déjà).
Récupérez le code SQL de création des tables NIVEAUX dans le fichiers /tmp/instal_sql.php
Depuis PGAdmin, avec un utilisateur ayant les droits suffisants, exécutez le code sql.
Ce code va :
* Créer un schéma *niveaux*
* Créer les tables et les peupler avec des données test
* Créer un user NIVEAUX admin
SUPRRIMEZ le fichier /tmp/instal_sql.php
Bonne pratique :
Créez un user PostGRE spécifique pour l'outil Niv'Eaux, et accordez lui les droits d'usage sur le schéma niveaux, et les droits complets sur les tables et séquences. Utilisez ce user pour parémtrer les informations de connexion à la base de données dans le fichier de configuration de l'étape suivante.
**Bonne pratique :**
Créez un user PostGRE spécifique pour l'outil Niv'Eaux, et accordez lui les droits d'usage sur le schéma niveaux, et les droits complets sur les tables et séquences. Utilisez ce user pour paramétrer les informations de connexion à la base de données dans le fichier de configuration de l'étape suivante.
### Fichier de configuration
......@@ -51,7 +55,7 @@ A partir du fichier utils/conf_template.php, créer un fichier /utils/conf.php c
### Configuration Apache
Assurez-vous que votre nom de domaine pointe bien vers votre dossier d'installation de NIVEAUX/public.
Assurez-vous que votre nom de domaine pointe bien vers votre dossier d'installation de NIVEAUX**/public**.
## Première connexion
......@@ -61,9 +65,10 @@ Déclarez vos points de suivi *Points de suivi/Nouveau point de suivi*
## Relevés automatiques
Dans la base de données, dans la table *tache_planifiee*, sur la base des modèles, créer vos tâches de type relevés vigicrue ou infoclimat.
Vous pouvez rendre inactives les tâches exemples (actif = FALSE)
Dans la base de données, dans la table *tache_planifiee*, sur la base des modèles, créez vos tâches de type relevés vigicrue ou infoclimat.
Vous pouvez rendre inactives les tâches exemples (actif = FALSE).
NE SUPPRIMEZ pas la tâche *controle notification*.
Sur votre serveur web, créez une tâche CRON, planifiée au rythme souhaité (par exemple toutes les 10 minutes), executant la commande suivante :
```sh
$ php /var/www/XXXXXXX/Niveaux/Console/console.php cron
......@@ -73,7 +78,7 @@ Une fois que vous vous êtes assurés que les relevés s'effectuent correctement
## Contributions
Créez un compte sur notre plateforme Gitlab pour ouvrir des tickets (signaler les bugs) ou proposer des améliorations du code.
Créez un compte sur notre plateforme Gitlab pour ouvrir des tickets (signaler les bugs) ou proposer des améliorations du code : http://gitlab.sevre-nantaise.com/users/sign_in
## Auteur
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment