-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feat : add doc for module installation
- Loading branch information
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Installation/Désinstallation du module | ||
|
||
## Prérequis | ||
|
||
- Avoir [installé GeoNature](https://github.com/PnX-SI/GeoNature) en version v2.9.2 ou plus. | ||
|
||
## Installation | ||
|
||
**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](https://github.com/PnX-SI/gn_module_suivi_flore_territoire/releases) : | ||
```bash | ||
wget https://github.com/PnX-SI/gn_module_suivi_flore_territoire/archive/X.Y.Z.zip | ||
``` | ||
2. Créez un dossier qui contiendra vos modules : | ||
```bash | ||
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 : | ||
```bash | ||
source backend/venv/bin/activate | ||
``` | ||
5. Installez le module avec la commande : | ||
```bash | ||
geonature install-packaged-gn-module --build false /home/${USER}/modules/gn_module_suivi_flore_territoire SFT | ||
``` | ||
- Adaptez le chemin `/home/${USER}/modules/gn_module_suivi_flore_territoire` à votre installation. | ||
6. Complétez la configuration du module uniquement si nécessaire : | ||
```bash | ||
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_priority_flora/conf_schema_toml.py` | ||
7. Mettre à jour le frontend : | ||
```bash | ||
geonature update-configuration --build false && geonature generate-frontend-tsconfig && geonature generate-frontend-tsconfig-app && geonature generate-frontend-modules-route | ||
``` | ||
8. 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 : | ||
```bash | ||
geonature db downgrade sft@base | ||
``` | ||
1. Désinstaller le package du virtual env : | ||
``` | ||
pip uninstall gn-module-suivi-flore-territoire | ||
``` | ||
- Possibilité de voir le nom du module avec : `pip list` | ||
1. Supprimer la ligne relative au module dans `gn_commons.t_modules` | ||
1. Supprimer le lien symbolique du module dans les dossiers : | ||
- `geonature/external_modules` | ||
- `geonature/frontend/src/external_assets/` | ||
1. Mettre à jour le frontend : | ||
```bash | ||
geonature update-configuration --build false && geonature generate-frontend-tsconfig && geonature generate-frontend-tsconfig-app && geonature generate-frontend-modules-route | ||
``` |