Les paquets d'installation Windows#

En 2021, OCARHY fonctionnait via des paquets d'installation Windows liés à OSGEO for windows (OSGEO4W). Cela sera abandonné en 2022, pour un développement lié à GitLab. C'était une méthode pratique mais obsolète pour des utilisateurs Linux et aussi inutilisable par rapport à la nouvelle version de l'executable OSGEO4W.

Obsolète

Il s'agit de l'ancienne méthode de création des paquets d'installation. Un changement de méthode de déploiement est actuellement en cours de développement. Cette partie de la documentation a été rédigé pour comprendre l'historique de l'outil.

1. L'objectif de l'installation#

OCARHY doit être installé sur les PC de nos utilisateurs. Le problème étant qu'il est nécessaire que les utilisateurs comprennent rapidement comment réaliser l’installation et comment paramétrer la configuration des profils QGIS d’OCARHY (la version bureau et la version portable).

L’ouverture des deux versions d’OCARHY par l’utilisateur

L’idée est de proposer sur les PC des utilisateurs deux raccourcis pour les 2 versions respectives d'OCARHY. Quand ils exécuteront le raccourci bureau, ils lanceront un petit exécutable (.bat) qui contient toutes les configurations nécessaires pour lancer QGIS avec le profil utilisateur associé (et d’autres paramètres), de même pour la version portable. Mais pour ce faire il va être nécessaire que l’utilisateur installe sur son PC ces raccourcis, puis ces exécutables, qu’il installe QGIS s’il ne l’a pas déjà et qu’il installe des profils utilisateurs dans les fichiers sources de QGIS.

2. Les éléments d'installation#

L'objectif est de créer des paquets d'installation qui se chargerons de répartir dans le PC de l'utilisateur les éléments d'OCARHY. L’idée est d’envoyer aux utilisateurs un fichier zippé qui une fois décompressé par l’utilisateur dévoile un contenu de 3 fichiers.

L'installateur OSGEO4W
Le paquet d’installation
Un executable .bat spécifique à OCARHY

Les éléments d'installation d'OCARHY

2.1. L'installateur OSGEO4W#

L'executable OSGEO4W permet à partir des paquets d'installation d'installer sur le PC de l'utilisateur les éléments d'OCARHy sur le PC

Installateur OSGEO

Vous pouvez le télécharger sur la page principale de téléchargement et d’installation de de QGIS l'executable OSGEO4W

2.2. Le contenu du paquet d'installation#

Le paquet d'installation contient toutes les ressources pour faire fonctionner les ressources d'OCARHY sur le PC de l'utilisateur. Pour faire nos paquets nous aurons besoin de 4 éléments :

Le paquet d’installation de QGIS et OCARHY : Quand ils vont lancer l’installation du paquet d’installation, il faut que les utilisateurs puissent installer QGIS si jamais ils ne l'ont pas. Pour cela, il faut récupérer le paquet d’installation de QGIS. Pour se faire, il faut installer QGIS sur le PC, et récupérer les fichiers téléchargés temporairement dans notre PC qui permettent l’installation de QGIS. Ils sont situés dans le chemin Local\Temp
Les profils QGIS (et autres éléments liés) : Les profils QGIS sont récupérables dans le fichier AppData. L'objectif est d’envoyer ces profils dans les fichiers sources du PC de l’utilisateur.
Un script de « post-installation » : Les scripts doivent être rédigés. Ils permettent de créer des raccourcis et de paramétrer les chemins d'installation.
Un script « d’ouverture » : Ces fichiers doivent être rédigés. Ils seront enregistrés dans le PC de l’utilisateur pour permettre de faire fonctionner les raccourcis.

2.3. L'exectuable OCARHY#

Ce fichier permet d'executer le lanceur OSGEO4W selon une configuration précise pour permettre une installation rapide sans demander l'intervention de l'utilisateur.

3. Paramétrer les éléments d'installation.#

Voici comment procéder pour créer les éléments pour l'isntallation d'OCARHY.

3.2.1. Prérequis#

En amont, il est nécessaire de télécharger certains logiciels :

3.2.1. Créer les ressources du paquet#

1/ Créez un dossier vierge et appelez le « Installation_OCARHY »
2/ Téléchargez l’exécutable OSGeo4W vous pouvez le retrouver directement sur le site d’installation de QGIS
3/ Renommez l’exécutable « Installateur_OSGEO »
4/ Glissez « Installateur OSGEO » dans le dossier « Installation OCARHY »
5/ Exécutez l’« Installateur OSGEO » et téléchargez QGIS (et les paquets que vous souhaitez avoir à côté)
Lors de l’installation, il télécharge temporairement les fichiers pour l’installation pour pouvoir ensuite (sans le voir) installer les paquets sur votre PC dans votre répertoire QGIS/OSGEO. Lors de l’installation, bein choisir tous les paquets que vous désirez intégrer à l’outil, GRASS, QGIS (et sa version), Python, etc…
6/ Récupérez le dossier de téléchargement des paquets qui est stocké temporairement sur votre PC dans AppData\Local\Temp (le miens : C:\Users\mrival\AppData\Local\Temp). Ce dossier est généralement intitulé : http%3a%2f%2fosgeo4w-oslandia.com%2fmirror%2f (il contient le terme « Oslandia »).

Accéder au dossier AppData

Sur Windows l’accès à appdata peut être masqué depuis l’explorateur, vous pouvez néanmoins l’atteindre en tapant dans votre barre de recherche windows %appdata %.

7/ Copier le contenu du dossier Temp, à partir du dossier x86_64, dans le dossier Installation_OCARHY
8/ Créez un dossier dans Installation_OCARHY/x86_64/release se nommant PAQUET, à côté des autres paquets d’installation téléchargez via OSGEO4W.
9/ Dans ce dossier PAQUET, créez l’arborescence de dossier apps/ocarhy. Ce qui nous comme arborescence finale

C:\Users\Utilisateur\Documents\TEMPORAIRE\ocarhy\etc\apps\ocarhy

10/ Copier les profils utilisateurs (dont vous avez pris le soin de personnaliser) dans C:\Users\mrival\AppData\Roaming\QGIS\QGIS3\profiles batch dans le dossier « ocarhy » que vous avez créez (etape 9). Il faut copier les dossiers des profils personnalisés, vous n’avez pas besoin de copier defaut (à moins qu’il s’agisse du profil sur lequel vous avez personnalisé l’interface)

3.2.2. Créer le script post-install#

Le script post install est appelé à la fin de l'installation. Il permet de configurer les path et les variables d'environnement. On l'utilise pour créer les raccourcis et déplacer certains éléments dans les fichiers sources de l'outil.

# Ne pas afficher la console cmd
@echo off

# On appelle à des exécutables installer précédemment pour faire réussir l’installation
call %OSGEO4W_ROOT%\bin\o4w_env.bat
call %OSGEO4W_ROOT%\bin\py3_env.bat

:: overwrite QGIS3.ini
# Il va prendre le dossier situé sur la racine « OSGEO4W », copier le profile et le coller dans la racine « %APPDATA% » renseignée et écraser les fichiers.


mkdir "%APPDATA%\QGIS\QGIS3\profiles\"
copy /Y "%OSGEO4W_ROOT%\apps\ocarhy" "%APPDATA%\QGIS\QGIS3\profiles\ocarhy\QGIS"
mkdir "%APPDATA%\postgresql"
copy /Y "%OSGEO4W_ROOT%\apps\ocahry\pg_service.conf" "%APPDATA%\postgresql\.pg_service.conf"

:: install shortcuts on desktop
nircmd shortcut "%OSGEO4W_ROOT%\apps\ocahry\ocahry_launch.bat" "~$folder.desktop$" "Mon_raccourci "%OSGEO4W_ROOT%\apps\ocahry\ocahry_.qgs" "%OSGEO4W_ROOT%\apps\ocahry\icon.ico" "" "min"

3.2.2. Créer les launchers#

Vous l’avez remarqué, on fait appel à deux raccourcis dans le script post-install, un pour chacune des versions de OCARHY. Il va donc être nécessaire de créer deux raccourcis.

Configuration de la version bureau

# Ne pas afficher la console cmd
@echo offset

# Création de la variable « ocarhy » qui correspond au chemin où est situé notre fichier « launcher » lors de son installation. Cette variable est utilisée dans la suite du script.
ocarhy=%~dp0

# Création de la variable « osgeo_root » qui correspond à « C:\OSGeo4W64\apps\ocarhy ». Cette variable est utilisée dans la suite du script.
set osgeo_root=%ocarhy:apps\ocarhy=%

# On appelle à l’exécution de scripts python et OSGEO4W (précédemment installés par le paquet) qui vont permettre à un lancement optimal de QGIS, 
call %osgeo_root%\bin\o4w_env.bat
call %osgeo_root%\bin\py3_env.bat

# Lancement de QGIS avec le profile déjà paramétrés
start "QGIS" /B "%OSGEO4W_ROOT%\bin\qgis-bin.exe" --profile bureau %1

Configuration de la version bureau

# Ne pas afficher la console cmd
@echo offset

# On créé la variable « OCARHY » qui avec la variable %~dp0 est initialisée par défaut dans l’endroit originel.
ocarhy=%~dp0

# On créé la variable « osgeo_root » dans notre système. Elle pourra être appelée par «%osgeo_root % dans nos chemins. Donc ici, on fait appel à l’OSGEO installé dans notre package « OCARHY ».
set osgeo_root=%ocarhy:apps\ocarhy=%

# On exécute les packages dans le fichier d’installation de OSGEO nécessaires au bon fonctionnement de nos extensions et de QGIS.
call %osgeo_root%\bin\o4w_env.bat
call %osgeo_root%\bin\py3_env.bat

# On exécute QGIS
# /B permet de démarrer l’application sans créer une nouvelle fenêtre. Ca permet d’executer QGIS sans vraiment trop d’erreur
# « chemin » On indique le chemin de QGIS
start "QGIS" /B "%OSGEO4W_ROOT%\bin\qgis-bin.exe" --profile bureau %1

3.2.2. Finaliser le paquet#

1/ Sélectionnez apps et etc
2/ Faites un clic droit sur ces dossiers et choisissez d’archiver avec 7zip votre sélection
3/ Archivez le dossier en .tar (via 7zip)
4/ Archivez l’archive .tar en .bzip2 (rendant un fichier .tar.bz2 via 7zip)
5/ Ouvrez le setup.ini dans le dossier x86_64
6/ Ajouter une section avec le nom du paquet dans le setup.ini, à la fin du dossier.

@ ocarhy
sdesc: "ocarhy"
ldesc: "ocarhy"
category: Libs
version: 1.2.0-1
install: x86_64/release/ocarhy/ocarhy-1.2.0-1.tar.bz2 58954065 f0f26780203fdfaf85d1de7d5bb033a5

Version: Respectez bien le nomenclature d’écriture des versions
Install: renseignez le chemin du fichier.

7/ Récupérer le poids du fichier (avec le numéro de version) :

stat --printf="%s" ocarhy-x.x.x-x.tar.bz2

8/ Copiez le poids du fichier et collez-le à la place du texte du code (en Orange) dans le Setup.ini
9/ Récupérez le « hash » du fichier ; Il permet de vérifier que rien n’a été perdu lors du transfert du fichier vers un autre poste. (avec le numéro de version)

md5sum ocarhy-x.x.x-x.tar.bz

10/ Copiez-collez le hash à la place du texte du code (en Bleu) dans le Setup.ini
11/ Relancer l’exécutable en local directory

Script post-install#

Rédaction en cours...