Skip to content

Latest commit

 

History

History
81 lines (68 loc) · 3.87 KB

install.md

File metadata and controls

81 lines (68 loc) · 3.87 KB
Raw

Installation/Désinstallation du module

Prérequis

Installation

Installation en production

Notes : l'installation proposée ici est en mode développement. Pour la production, supprimez les options --build false des commandes.

  1. Téléchargez le module sur votre serveur à partir d'une release : 
    wget https://github.com/PnX-SI/gn_module_monitoring_habitat_station/archive/X.Y.Z.zip
  2. Créez un dossier qui contiendra vos modules : 
    mkdir /home/${USER}/modules
  3. Dézippez dans /home/${USER}/modules avec : 
    unzip X.Y.Z.zip
  4. Placez-vous dans le dossier de GeoNature et activez le venv : 
    source backend/venv/bin/activate
  5. Installez le module avec la commande : 
    geonature install-gn-module --build false /home/${USER}/modules/gn_module_monitoring_habitat_station
    • Adaptez le chemin /home/${USER}/modules/gn_module_monitoring_habitat_station à votre installation.
  6. Complétez la configuration du module uniquement si nécessaire : 
    nano config/conf_gn_module.toml
    • Vous trouverez les paramètres possibles dans le fichier : config/conf_gn_module.toml.example.
    • Les valeurs par défaut dans : backend/gn_module_monitoring_habitat_station/conf_schema_toml.py
  7. Mettre à jour le frontend : 
    geonature update-configuration --build false && geonature generate-frontend-module-config MHS
  8. Vous pouvez sortir du venv en lançant la commande : deactivate

Installation en développement

  • Cloner le module avec le protocole SSH : git clone git@github.com:PnX-SI/gn_module_monitoring_habitat_station.git
  • Placez-vous dans le dossier de GeoNature et activez le venv : source backend/venv/bin/activate
  • Installez le module dans GeoNature avec la commande : geonature install-packaged-gn-module --build false /home/${USER}/modules/gn_module_monitoring_habitat_station MHS
    • Réinstaller le paquet Python pour tenir compte des dépendances de développement : pip install -e /home/${USER}/modules/gn_module_monitoring_habitat_station[dev]
  • Complétez la configuration du module uniquement si nécessaire : nano config/conf_gn_module.toml
    • Vous trouverez les paramètres possibles dans le fichier : config/conf_gn_module.toml.example.
    • Les valeurs par défaut dans : backend/gn_module_monitoring_habitat_station/conf_schema_toml.py
  • Mettre à jour le frontend : geonature update-configuration --build false && geonature generate-frontend-tsconfig && geonature generate-frontend-tsconfig-app && geonature generate-frontend-modules-route
  • Vous pouvez sortir du venv en lançant la commande : deactivate

Désinstallation

⚠️ ATTENTION : la désinstallation du module implique la suppression de toutes les données associées. Assurez vous d'avoir fait une sauvegarde de votre base de données au préalable.

Suivez la procédure suivante :

  1. Rétrograder la base de données pour y enlever les données spécifiques au module : 
    geonature db downgrade monitoring_habitat_station@base
  2. Désinstaller le package du virtual env : 
    pip uninstall gn-module-monitoring-habitat-station
    • Possibilité de voir le nom du module avec : pip list
  3. Supprimer la ligne relative au module dans gn_commons.t_modules
  4. Supprimer le lien symbolique du module dans les dossiers :
    • geonature/external_modules
    • geonature/frontend/src/external_assets/
  5. Mettre à jour le frontend : 
    geonature update-configuration --build false && geonature generate-frontend-tsconfig && geonature generate-frontend-tsconfig-app && geonature generate-frontend-modules-route