Installer l'application sur ses serveurs

Cette page s'adresse à l'administrateur technique qui installe MyZapp sur ses propres serveurs (installation dite « on-premise »). Une instance hébergée par l'éditeur n'a rien à installer.

L'installation repose sur Docker : l'application et sa base PostgreSQL tournent chacune dans un conteneur, et toutes les données vivent dans deux volumes. Rien n'est à compiler.

Ce que vous recevez

l'image Docker de l'application, en fichier .tar ou à tirer depuis un registre privé ;
le fichier d'orchestration docker-compose.onprem-client.yml ;
le modèle de réglages .env.template ;
le script generate-secrets.sh, qui crée les mots de passe de la base ;
le script init-condition-sql-role.sql, monté par le fichier d'orchestration ;
un dossier views-override/ vide.

Prérequis : Docker Engine (ou Docker Desktop) avec Docker Compose v2, 2 Go de mémoire et 10 Go de disque au minimum.

Installer

Si l'image est livrée en fichier, chargez-la : docker load -i suivi du nom du fichier .tar.
Copiez .env.template en .env, puis renseignez au moins WEBBASE_IMAGE (l'image à utiliser) et APP_PORT (le port de l'application, 8080 par défaut).
Lancez ./generate-secrets.sh. Il crée le dossier secrets/ avec deux mots de passe aléatoires pour PostgreSQL. Ces mots de passe ne figurent jamais dans .env ; sans eux, Docker Compose refuse de démarrer.
Démarrez : docker compose -f docker-compose.onprem-client.yml up -d.
Ouvrez l'application dans le navigateur, à l'adresse du serveur et sur le port choisi : l'assistant de configuration s'affiche.

L'assistant de configuration

L'assistant ne s'affiche qu'une fois, sur une instance neuve. Il compte quatre étapes.

Base de données (Connexion PostgreSQL) : Hôte, Port, Base de données, Utilisateur, Mot de passe et Chiffrement de la connexion. Avec le fichier d'orchestration livré, la base s'appelle webbase-postgres et le mot de passe se laisse vide : l'application lit celui du dossier secrets/. Tester la connexion vérifie les valeurs avant de passer à la suite.
Compte administrateur initial : Nom d'affichage, Adresse e-mail et Mot de passe du premier administrateur.
Clefs de sécurité : la clef de signature des jetons d'API, la clef de chiffrement des données et la clef de chiffrement de la double authentification sont générées au hasard. Exporter les télécharge : conservez-les en lieu sûr, elles ne peuvent pas être récupérées après la configuration. Régénérer en tire de nouvelles.
Récapitulatif de configuration : saisissez l'Adresse publique de l'instance, en https://, celle que les utilisateurs ouvriront. Elle sert à construire les liens envoyés par e-mail. Cochez au besoin Installer des données de démonstration du catalogue de services, puis Appliquer et démarrer.

L'application exécute ses migrations, crée le compte administrateur, puis redémarre d'elle-même : patientez quelques secondes avant d'ouvrir la page de connexion. Le fichier d'orchestration livré la relance automatiquement.

L'assistant s'affiche dans la langue du navigateur quand elle est disponible (français, anglais ou espagnol), sinon en français. Les liens en haut de la page changent de langue à tout moment ; le choix vaut pour les étapes suivantes.

Passer en HTTPS

L'application n'est prise en charge qu'en HTTPS : hors poste de test, ses cookies de session ne circulent que sur une connexion chiffrée, et une connexion en HTTP n'aboutit pas. Placez devant elle un proxy inverse (nginx, Traefik…) qui porte le certificat et transmet les requêtes au port de l'application.

Le proxy doit transmettre les en-têtes X-Forwarded-For et X-Forwarded-Proto. Par défaut, l'application ne les croit que venant de la machine elle-même ou d'un réseau privé. Pour ne croire que le proxy, renseignez TRUSTED_PROXIES (son adresse vue par le conteneur) ou TRUSTED_NETWORKS (son réseau) dans .env.
Le port de l'application ne doit être joignable que par le proxy : fermez-le au pare-feu, ou publiez-le seulement sur la boucle locale.

Vérifier l'installation

L'adresse /health de l'instance répond Healthy quand l'application et sa base fonctionnent.
L'écran État de l'instance donne la version, la base de données, l'espace disque et les modules activés (voir « Surveiller l'instance »).
Activez ensuite la licence de l'instance (voir « Gérer les licences de l'instance »), puis importez la documentation livrée avec la version (voir « Mettre à jour la documentation »).

L'outil d'administration de la base

pgAdmin est livré mais ne démarre pas par défaut. Pour l'utiliser, renseignez PGADMIN_EMAIL et PGADMIN_PASSWORD dans .env, puis démarrez avec l'option --profile admin. Il écoute sur le port PGADMIN_PORT (5050 par défaut). Arrêtez-le quand vous n'en avez plus besoin.

Voir aussi

« Mettre à jour et sauvegarder l'application » : sauvegarde, restauration, montée de version et retour arrière.
« Charger les données de démonstration » : remplir une instance de test.
« Changer la connexion à la base de données » : modifier l'accès à PostgreSQL après l'installation.