Installation sur Windows

De Support e-comBox

Cette page traite de l'installation et des particularités sur Windows 10 professionnel, entreprise ou éducation. Vous trouverez les prérequis ici.

Installation de l'e-comBox : mode opératoire détaillé

L'installation de l'e-comBox se fait via un setup disponible en téléchargement ici.

Warning Warning: Utilisez Firefox si Chrome empêche le téléchargement d'un exécutable non signé.

L’installation crée un dossier e-combox dans le répertoire d'installation des applications C:\Programmes. le dossier créé contient notamment la documentation (avec les codes d'accès aux différents backoffice) et un dossier scripts dans lequel se trouve un ensemble de programmes utiles à la reconfiguration de l'environnement de travail.

L'installation installe dix raccourcis dans un dossier e-comBox du menu Démarrer :

Win-ecombox-raccourcis.png
  • Aide en ligne permet d'accéder à cette documentation
  • Démarrer e-comBox démarre l'application et lance l'application dans le navigateur (à  noter qu'il faut modifier la configuration pour que Docker ne se lance pas automatiquement au démarrage de la machine - voir plus loin) ;
  • Optimiser l'espace disque libère l'espace disque qui n'est plus utilisé par l'e-comBox (cette fonctionnalité est prise en charge automatiquement au lancement de l'e-combox lorsque le système le juge nécessaire) ;
  • Réinitialiser l'environnement lance l'e-comBox en prenant en compte un changement d'environnement (nouvelle adresse IP par exemple) et donne la configuration du proxy ;
  • Stopper e-comBox stoppe l'application après en arrêtant le service Docker (et libère donc la mémoire correspondante pour le système) ;
  • Sécuriser l’accès à l’interface permet d’ajouter un système d’authentification pour accéder à l'e-comBox ;
  • Supprimer l’authentification supprime le système d’authentification créé par le script précédent ;
  • Supprimer tous les sites supprime tous les sites et réinitialise l'e-comBox ;
  • Synchroniser le mot de passe de Portainer permet de modifier le mot de passe utilisé par l'e-comBox pour accéder à Portainer si le mot de passe de ce dernier a été modifié ;
  • Vérifier et configurer l'environnement lance un programme textuel qui permet de vérifier l'environnement et de changer certains composants comme la mémoire vive utilisée ou l'adresse IP utilisée pour l'e-comBox (et non l'adresse IP du système).


Note Note: L'installateur crée également une icône sur le bureau qui pointe vers le raccourci de Démarrer e-comBox.

Pour le bon fonctionnement de l'application il sera aussi créé, dans le répertoire par défaut de l'utilisateur :
  • un dossier "e-comBox_portainer" ;
  • un dossier "e-comBox_reverseproxy ;
  • un dossier caché .docker dans lequel on trouvera notamment les logs et le fichier param.conf qui contient les paramètres tels que les adresses IP, les numéros de port utilisés, le proxy.


Déroulement du setup

Au lancement, il faudra certainement confirmer à plusieurs reprises que l'on veut autoriser l'application :

DocEcomBox-images-image2.png

Warning Warning: Il est nécessaire de cliquer sur Informations complémentaires pour faire apparaître le bouton Exécuter quand même et ainsi pouvoir exécuter le setup.

Setup1 avertDefender.JPG


L'installation de pré-requis comme l'activation de WSL2 nécessite d'être administrateur sur la machine et il faut donc autoriser l'application à apporter les modifications nécessaires :

Setup1bis avertDefender.JPG


Setup2 install.JPG


La suite est classique :

  • acceptation de la licence ;
  • un récapitulatif des conditions d'utilisation et des répertoires utilisés ;
  • la liste des composants nécessaires ;
  • un récapitulatif global avant le lancement effectif de l'installation via le bouton Installer ;
Win-ecombox-recap.png


Win-ecombox-install.png


  • installation de Git pour Windows ;
  • activation de WSL2 ;
  • installation de Docker avant un redémarrage :
Win-ecombox-restart.png


ConfigProxy/images/image3.jpg
Warning Warning: Au redémarrage de la machine, le lancement de Docker dure environ 2 minutes.

Un survol sur l'icône de Docker dans la barre des tâches informe que Docker is starting. Lorsque Docker a démarré, l'icône se stabilise et informe, lors du survol, que Docker is running.

Si Docker ne se lance pas, c'est que vous aviez peut-être , dans une précédente installation, décoché la case de lancement de Docker au démarrage. Il est nécessaire alors de saisir "Docker Desktop" dans la barre de tâche de Windows et de le lancer.


Quand Docker se lance pour la première fois, une fenêtre apparaît, cette dernière peut être fermée.

Win-ecombox-welcome.png


Warning Warning: Après avoir validé le récapitulatif, un message informe que Docker doit être démarré avant de continuer ce qu'il faut absolument respecter !
Setup7bis install.JPG


Dans le cas où vous utilisez un proxy sur votre machine pour votre connexion Internet, l'installateur le détecte, vous en informe et vous donne les valeurs à saisir au niveau de l'interface graphique de Docker (une page vers la documentation spécifique de la configuration du proxy sur Docker s'ouvre, il faut donc revenir à l'installation). En voici un exemple (qui est forcément différent de votre propre configuration):

Win-ecombox-proxy.png


Warning Warning: Il faut IMPÉRATIVEMENT exclure du proxy sur Docker ET sur le système le réseau dans lequel est le serveur d'ecomBox et le réseau dans lequel se trouve le proxy.

Il faut alors cliquer droit sur l'icône de Docker qui ouvre une fenêtre puis sélectionner Settings :

Win-ecombox-settings.png

Un clic sur Resources permet de configurer le proxy. Il faut alors activer la configuration manuelle en cliquant sur Manual proxy configuration (puis cliquez sur Apply and restart pour redémarrer Docker).

Warning Warning: L'image ci-dessous n'est qu'un exemple, il faut écrire les valeurs données par le setup d'installation. Les items du "ByPass" doivent être séparés par des virgules :


Win-docker-proxy.png


Quand Docker a redémarré (le bouton Apply devient grisé), vous pouvez fermer la fenêtre de Docker et  poursuivre pour finaliser l'installation.

DocEcomBox/images/image11.png

Si la case Exécuter l'initialiser l'application est cochée, l'e-comBox est lancée automatiquement à la fin de l'installation.

Un message vous alerte que l'initialisation de l'installation est en cours. Vous pouvez fermer cette fenêtre et attendre que l'e-comBox se lance dans votre navigateur par défaut.

Setup8 install.JPG


Warning Warning: Vous aurez peut-être à autoriser l'accès à un composant de Docker auprès de votre pare-feu :

DocEcomBox/images/image8.png


Warning Warning: Puisque le serveur est accessible à distance, il est nécessaire de configurer une authentification à l'interface d'e-comBox et de modifier le mot de passe admin de Portainer puis de synchroniser ce mot de passe avec l'application e-comBox (voir ici.)

Lancement de l'e-comBox

Il est nécessaire de lancer l'e-comBox en utilisant l'icône du bureau ou bien le lien du menu de démarrage.

Préalables

Warning Warning: En cas de modification de l'environnement, comme un changement d'adresse IP ou l'ajout (voire la désactivation) d'un proxy, il est nécessaire de réinitialiser l'environnement (via le lien du menu de démarrage) avant de lancer e-comBox. Le script de lancement peut éventuellement détecter une incohérence et vous proposer cette réinitialisation.

Note Note: Si besoin, il est également nécessaire de configurer le Proxy (ou en supprimer la configuration) via l'interface graphique de Docker.

En cas de page blanche pour e-comBox (cela arrive aussi quand la page est restée ouverte très longtemps sans activité), il est nécessaire de :

  • vider le cache ;
  • fermer le navigateur ;
  • relancer e-comBox.

En cas de problème relatif à un site qui n'est pas accessible via le réseau, il faut aussi vérifier :

  • le firewall: désactivez-le momentanément pour voir si le problème vient de là. Si c'est la cas, il faudra alors le configurer pour permettre l'accès aux ports ;
  • 'l'adresse IP utilisée par e-comBox : elle doit correspond à celle de la machine, si ce n'est pas le cas vous pouvez, après avoir essayé de rétablir les choses en réinitialisant e-comBox, fixer la bonne adresse IP en lançant le raccourci Vérifier et configurer l'environnement.

Voir ici si le problème persiste.

Interface de l'e-comBox

Lorsqu'on se connecte, un tableau de bord simplifié permet d'avoir une vue d'ensemble sur le nombre de sites et la place qu'ils occupent en mémoire et en capacité.

DocEcomBox/images/image9.png

Note Note: Sur Windows, l'espace disponible, la mémoire utilisée et l'usage du CPU sont des indications relatives à la machine virtuelle créée et non à la machine physique.


Un clic, dans le menu de gauche sur Prestashop conduit à un écran similaire à ci-dessous :

DocEcomBox/images/image1.png


La prise en main de cette interface avec sa gestion de base (créer, démarrer, arrêter ou supprimer un site) ainsi que la gestion avancée est décrite plus précisément ici.

Gestion des ressources pour Docker

La machine virtuelle créée sous WSL2 dispose, par défaut, des ressources suivantes :

  • 4 Go de mémoire ;
  • d'une capacité de disque variable selon les sites installés qui ne peut aller au delà de 250 Go.

Note Note: Ces ressources peuvent être optimisées.

Config1WSL2.JPG

Pour gérer la mémoire, il est nécessaire d'activer le menu "Vérifier et configurer l'environnement" :

  • le système détecte la quantité de mémoire dont vous disposez ;
  • il vous propose de modifier la quantité de mémoire dédiée à l'e-comBox.


Si vous cliquez sur "Oui", le script vous propose de saisir une nouvelle valeur pour la quantité de mémoire (par exemple 5 Go comme ci-dessous) :

Config3WSL2.JPG

Warning Warning: Attention à laisser au moins 3/4 GB, ce qui est nécessaire à Windows pour fonctionner correctement.

Après validation, Docker redémarre ensuite pour activer le changement.

Sur Windows, il n'est pas permis pour le moment une utilisation dynamique des ressources de Docker qui sont fixes même si aucun site n'est lancé.

Warning Warning: Une bonne pratique consiste à ne lancer e-comBox que si besoin. Ce qui permet d'augmenter les ressources au maximum en tenant compte des capacités de votre machine.

Attention, dans ce cas, il est nécessaire de :

  • stopper e-comBox (via le raccourci correspondant) dès que l'application n'est plus utilisée ;
  • désactiver Docker au démarrage de la machine en décochant la case correspondante :

ConfigDemarrage.png

L'optimisation de l'espace disque se réalise théoriquement automatiquement. Au lancement de l'application, le système détecte s'il est nécessaire d'optimiser et si c'est le cas, une tentative d'optimisation a lieu.

Warning Warning: Cette dernière manipulation peut être réalisé à part via le menu Optimiser l'espace disque mais si cela ne vous l'est pas proposé au lancement de l'application, c'est que cette optimisation n'est pas véritablement nécessaire au regard des capacités de votre poste.

Désinstallation de l'e-comBox

La désinstallation via le raccourci prévu lors de l'installation supprime proprement l'application mais ne supprime pas les pré-requis installés. Pour ce faire, et si vous n'en avez plus besoin, il est nécessaire de procéder à leur désinstallation selon la procédure décrite ci-après.

Warning Warning: Si vous ne disposez pas du raccourci Désinstaller e-comBox, vous devez utiliser Ajouter ou supprimer des programmes puis sélectionner e-comBox.

Pour désinstaller Git et Docker, il faut utiliser Ajouter ou supprimer des programmes puis sélectionner le programme à supprimer.

DocEcomBox/images/image13.png



Et activez Désinstaller. Par exemple, pour Docker :

DocEcomBox/images/image14.png


La fonctionnalité HyperV a été activé si vous avez installé la première version de l'e-comBox. Elle peut être désactivée.

Les deux fonctionnalités suivantes sont activées lors de l'installation de la deuxième version :

  • Plateforme d'ordinateur virtuel.
  • Sous-système Windows pour Linux.

Pour désactiver une ou plusieurs fonctionnalités, il faut utiliser Activer ou désactiver des fonctionnalités Windows et décocher les cases correspondantes puis cliquer sur OK (un redémarrage sera nécessaire) :

Par exemple, pour HyperV :

DocEcomBox/images/image20.jpg

Pour Plateforme d'ordinateur virtuel et Sous-système Windows pour Linux : Desintallation.JPG