Premiers pas - v4

L’application e-comBox est une application Web qui permet de lancer et gérer un certain nombre de sites basés sur les applications suivantes :

• Prestashop :
  • une instance de démonstration (appelée "vierge" dans e-comBox),
  • une instance sans aucune données (appelée "BASE" dans e-comBox),
  • deux instances personnalisées :
    • site Art Concept Stories ;
    • site Sweety Bio;
• WordPress avec WooCommerce :
  • une instance vierge,
  • une instance personnalisée (site Art Concept Stories) ;
• WordPress sans WooCommerce, mais avec le add-in H5P ;
• Mautic ;
• Suite CRM ;
• Odoo dans sa version 12,13, 14 15, 16 et 17 (ces 3 dernières versions ne sont disponibles qu'à partir de la 4.1) :
  • une instance vierge de chaque version,
  • six instances personnalisées (SweetyBio, AdA, generik, pépinières, primeur et surplomb) ;
• Kanboard (gestion de projet) :
  • une instance vierge,
  • une instance personnalisée (BdDev) ;
• HumHub (réseau social).

Depuis la version 3, il est possible de créer des sites à partir d'une image personnalisée.

Depuis la version 4.1, il est possible de partager un modèle site avec la communauté et de récupérer un modèle de site.

Depuis la version 4.4, il est possible de créer des sites à partir d'un fichier CSV, et de renseigner les informations d'un serveur de mails afin de pouvoir générer des comptes personnalisés sur les sites de type Odoo, Prestashop, Blog et Woocommerce.

L'installation de l'e-comBox est documentée pour Linux. Il n'est pas possible d'installer la version 4 sur Windows ou MacOS.

La version 4 nécessite de se connecter via un compte "Prof". Voir ici le mode opératoire.

Les éléments en gras dans le sommaire concernent des nouveautés ou des modifications apportées par la dernière version d'e-comBox (version 4.4).

L'interface de l'e-comBox

L'interface de l'e-comBox est composée d'un menu à gauche, d'un bandeau avec :

• un raccourci vers la page d'aide,
• un bouton pour accéder à la page de modification de mot de passe,
• un bouton pour se déconnecter,

et d'une zone principale qui s'adapte en fonction de l'élément de menu sélectionné :

Le tableau de bord permet d'avoir une vue d'ensemble sur :

• la version de l'e-comBox ;
• la version des scripts d'installation de l'e-comBox ;
• le nombre de sites créés ainsi que leur état (démarré ou stoppé) ;
• l'instance de l'e-comBox ;
• le nom de l'utilisateur connecté ;
• les ressources utilisées (mémoire, espace de stockage et CPU) en cliquant sur le lien correspondant.

Gestion des sites

Le menu gauche liste l'ensemble des types de sites disponibles : Prestashop, WooCommerce, Blog, Mautic, Suite CRM, Odoo, Kanboard et HumHub. Un clic sur chacun affiche la page de gestion correspondante.

Créer un site

Avec la sortie de la version 4.4, l'interface de création des sites fait peu neuve ! Il est dorénavant possible de créer des sites en important un fichier csv :)

Pour créer un site, vous disposez donc maintenant de deux options : manuellement ou via un fichier csv. Comme dans les versions précédentes vous devez choisir quel modèle utiliser puis sélectionner l'option de votre choix :

Créer un site manuellement

En premier lieu, vous devez choisir un nom. C'est le seul élément obligatoire.

Vous avez maintenant la possibilité d'ajouter un mot-clé qui vous permettra filtrer plus facilement les sites créés. Cet élément est optionnel.

Enfin, comme dans les précédentes versions, vous pouvez lancer la création de plusieurs sites à partir de cette configuration. Si vous ne saisissez rien, un seul site sera créé. Dans le cas où vous créez plusieurs sites, un numéro d'ordre (incrémenté) sera ajouté à la suite du nom choisi.

Au clic du bouton valider, vous pouvez choisir de créer plusieurs sites. Le nom du site sera de la forme : type de site-complément de nom.

Le complément de nom peut contenir des chiffres et/ou des lettres minuscules. Les accents et caractères spéciaux ne sont pas autorisés.

Après validation, un témoin d'activité apparaît. Lorsque le site est prêt un message (sous forme de pop-up) l'indique.

Le temps de création du site dépend de la qualité de la connexion internet et des ressources matérielles de la machine sur laquelle e-comBox est installée sachant que la première création d'un site est toujours beaucoup plus longue que les suivantes car l'image (qui est ensuite stockée sur la machine) est téléchargée.

Une fois la création terminée, le site est automatiquement démarré et la "carte" correspondante apparaît dans la zone Gérer les sites à partir d'un modèle fourni :

Créer un site via un fichier CSV (version 4.4)

Il est maintenant possible de créer des sites en important un fichier CSV. Cela va permettre plusieurs choses :

• personnaliser le nom pour chacun des sites
• ajouter un mot-clé comme pour la méthode manuelle
• ajouter une adresse mail.

Un fichier d'exemple est téléchargeable en cliquant sur le point d'interrogation. Il est également disponible ici.

Voici le format du fichier CSV à utiliser :

Seuls les noms et prénoms sont obligatoires. En effet, les noms des sites seront de la forme : type de site-nom-première_lettre_du_prénom. Si vous précisez un identifiant il sera concaténé à la suite.

La classe représente le mot-clé dont nous parlions précédemment lors de la création avec la méthode manuelle.

L'adresse mail va vous permettre de personnaliser de personnaliser les identifiants de connexion aux sites. Si vous précisez une adresse mail, au lieu des identifiants génériques normalement utilisés, l'identifiant sera alors l'adresse mail saisie et un mot de passe aléatoire sera généré. Ces identifiants de connexion, ainsi que le lien d'accès au site sera alors envoyé à l'adresse mail correspondante une fois la création du site terminée.

Fichier:OOjs UI icon notice-destructive.svg Avertissement :

L'adresse mail ne sera utilisée que si un server mail a été renseigné lors de l'installation de la version 4.4 de l'e-comBox. De plus, cette fonctionnalité n'est disponible qu'avec les types de site suivants : Prestashop, Blog, Woocommerce et Odoo.

Si un compte personnalisé a été créé en utilisant l'adresse mail saisie, le message "compte personnalisé" sera affiché à la place du message "compte par défaut" sur le site concerné tel que l'exemple ci-dessous. Pour rappel, les information de connexion des comptes génériques (compte par défaut) se situent en haut à droite de chaque page en cliquant sur le bouton "Informations de connexion".

Fichier:OOjs UI icon notice-destructive.svg Avertissement :

Cette fonctionnalité n'est pas disponible actuellement pour les sites Odoo créés à partir de vos propres modèles.

Modèles de sites

Pour les sites WooCommerce, il est possible de créer 2 types de sites :

• vierge : site par défaut proposé par WooCommerce ;
• Art Concepts Stories : e-boutique opérationnelle (300 références, 150 clients, 130 commandes).

Pour les sites Prestashop, il est possible de créer 4 types de sites :

• vierge : site par défaut proposé par Prestashop ;
• base : sans aucune données ;
• Art Concepts Stories : e-boutique opérationnelle (300 références, 150 clients, 130 commandes) ;
• Sweety Bio : autre e-boutique opérationnelle.

Il est donc nécessaire de choisir un type avant de cliquer sur le bouton créer :

De même pour les sites Odoo, il est possible de choisir entre les versions 12,13, 14, 15, 16 et 17 ou des images personnalisées :

Démarrer/arrêter un site

Un site démarré est affiché de la façon suivante :

Un clic sur le bouton bleu (interrupteur) permet alors d'arrêter le site. Un site stoppé est affiché de la façon suivante :

Un nouveau clic sur l'interrupteur permet de le démarrer.

Fichier:OOjs UI icon notice-destructive.svg Avertissement :

En cas de modification de l'environnement (changement de réseau par exemple), le démarrage d'un site peut prendre quelques minutes car une mise à jour est réalisée automatiquement afin de prendre en compte les modifications.

Filtrer et rechercher des sites (version 4.4)

Lorsque l'on commence à avoir de nombreux sites différents, il pouvait être difficile de s'y retrouver. Une barre de recherche a été mise en place afin de faciliter cela.

Il est possible de rechercher un site en fonction de son groupe (mot-clé), s'il a été défini lors de l'étape de création (comme décrit plus haut sur cette page) :

Ou de réaliser une recherche sur le nom d'un site directement :

Accéder à un site

Pour accéder à un site, ce dernier doit être démarré.

Un lien cliquable Accéder au site (redirigeant vers l'URL du site dans un nouvel onglet du navigateur) est affiché pour chaque site démarré.

Les URL peuvent être visualisées :

• Au survol du lien Accéder au site ou Site / Administration :

• Au clic sur le bouton Afficher les URL :

Fichier:OOjs UI icon check-constructive.svg Le bouton Afficher les URL n'apparaît qu'à partir du moment où au moins un site est démarré.

• Via un mail envoyé (version 4.4). Depuis la version 4.4, si un serveur mail a été renseigné et que vous utilisez la méthode de création via un fichier CSV en renseignant les adresses mail, un mail avec toutes les informations nécessaires sera transmis à l'utilisateur concerné :

Fichier:OOjs UI icon notice-destructive.svg Avertissement :

Le compte personnalisé et donc l'envoi de mail, est disponible uniquement dans le cas où un serveur mail a été configuré et pour les types de sites suivants : Prestashop, Odoo, Blog et Woocommerce.

Les URL sont au format http://<hôte ou adresse IP d'ecomBox>:<port du proxy>/<nom-du-site>/<chemin-backoffice> ou http://<hôte ou adresse IP d'ecomBox>/<chemin-reverse-proxy>/<nom-du-site>/<chemin-backoffice>. Par exemple, dans l'image ci-dessus, l'hôte est "cub.corsica", le chemin du reverse proxy est "dev" et le chemin vers le backoffice est "/wp-admin". Seuls les noms des sites changent (blog-eleve1, blog-eleve2, blog-eleve3 et blog-eleve4).

Exporter la liste des URL au format PDF

Pour chaque type de site (Prestashop, WooCommerce, Blog, etc.) il est possible d'afficher en un clic la liste des URL pour l'ensemble des sites démarrés. Pour cela, il suffit de cliquer sur le bouton Afficher les URL :

Le bouton Exporter permet de générer et d'ouvrir automatiquement un fichier PDF contenant cette liste :

Les URL sur ce fichier PDF sont cliquables.

Supprimer un site

Pour supprimer un site, il faut cliquer sur le bouton en haut à droite de la "carte" correspondante :

Fichier:OOjs UI icon notice-destructive.svg Avertissement :

La suppression est irréversible et les données associées au site seront supprimées !

Par sécurité, une confirmation est demandée : en cliquant sur Valider, après un petit temps de chargement (l'animation Loading est affichée), le site est supprimé.

Ce pop-up vous en averti en s'affichant en haut à droite de la page.

La carte associée disparaît alors de l'e-comBox.

Réinitialiser un site

En cliquant sur l'autre icône au niveau de la carte, cela va permettre de réinitialiser le site. Le système va supprimer le site existant (et ses données) et en recréer un du même nom avec le modèle utilisé initialement

Fichier:OOjs UI icon notice-destructive.svg Avertissement :

La réinitialisation est irréversible et les données associées au site seront supprimées !

Par sécurité, une confirmation est demandée : en cliquant sur Valider, après un petit temps de chargement (l'animation Loading est affichée), le site est supprimé puis recréé.

Dupliquer un site

En cliquant sur l'autre icône au niveau de la carte, cela permet de créer un modèle du site correspondant :

Cela permet de faire en sorte que les modifications que vous avez réalisées sur le site puisse servir de base pour la création de nouveaux sites. Une fois que vous avez cliqué sur le bouton pour dupliquer, une nouvelle boite de dialogue s'ouvre afin que vous puissiez choisir le nom de votre modèle :

Il est également possible de modifier un modèle déjà existant (partie de droite).

Plusieurs opérations sont réalisées lorsque vous créez un modèle, la création peut donc prendre plusieurs minutes. Une fois la création terminée, vous pouvez utiliser votre nouveau modèle pour créer des nouveaux sites à partir de ce dernier :

Une fois le site créé il apparaitra dans la deuxième liste :

Pour rappel, depuis la version 4.1, il est possible de partager vos modèles avec d'autres utilisateurs, mais également d'en importer (https://wiki-ecombox.btssio.corsica/index.php/Partager_une_image)

Fichier:OOjs UI icon notice-destructive.svg Avertissement :

En ce qui concerne les sites pour lesquels un compte personnalisé a été créé, il n'est actuellement pas possible de les dupliquer. Cette remarque concerne pour la version 4.4 uniquement.

Actions sur plusieurs sites

Il est possible de démarrer/arrêter/supprimer plusieurs sites simultanément. Pour cela, il faut activer le mode sélection :

Vous pouvez ensuite cocher "Tous les sites" pour sélectionner tous les sites, ou cliquer sur les sites que vous désirez sélectionner :

Et enfin, cliquez sur le bouton sur le bouton correspondant à l'action que vous désirez réaliser (démarrer/arrêter/supprimer).

Gestion avancée

La gestion avancée permet :

• d'accéder aux sources des sites Prestashop et Odoo ;
• d'accéder aux bases de données des sites Prestashop, WooCommerce et Blog ;
• d'administrer directement les conteneurs : à utiliser avec prudence.

Accès SFTP

L'accès SFTP permet d'accéder aux sources des sites Prestashop, WooCommerce, Blog et Odoo.

Sur cette page ne sont affichés que les sites Prestashop, WooCommerce, Blog et Odoo démarrés car pour activer le SFTP, le site associé doit obligatoirement être démarré.

Lorsque le SFTP est activé pour un site l'affichage est du type :

Une fois le SFTP activé, il est possible d'accéder aux sources de deux manières afin de faire d'éventuelles modifications (l'identifiant de connexion est ecb, un mot de passe aléatoire est généré. Ces deux informations figurent sur la carte).

Accéder aux sources à partir du client Web

Le client Web est à privilégier s'il n'est pas utile d'importer une arborescence entière (car c'est la seule fonctionnalité non présente).

Il suffit de cliquer sur l'URL fournie :

Voici un extrait du contenu des "addons" d'Odoo :

Accéder aux sources à partir du client SFTP

Un client SFTP (comme Filezilla) est à privilégier lors d'import d'une arborescence complexe, par exemple lorsque l'on veut ajouter un addon à Odoo.

Le nom d'hôte et le port nécessaires sont écrits sur la carte.

Le nom d'hôte peut être un nom de domaine ou une adresse IP.

Le port doit être ouvert (et non bloqué par un pare-feu). En cas d'accès externe, selon l'architecture réseau, il est possible qu'il y ait besoin d'une redirection de port.

Si on est positionné dans le réseau local, le nom d'hôte peut être remplacé par l'adresse IP privée du serveur e-comBox.

1. Sélectionner "Gestionnaire de sites" pou ajouter ou utiliser un site.
2. Sélectionner le protocole SFTP.
3. Saisir le nom d'hôte ou l'adresse IP (Rappel : si vous êtes dans un réseau local, il est possible d'utiliser l'adresse IP privée du serveur).
4. Saisir le port figurant sur la carte.
5. Laisser le type d'authentification "Normale"
6. Saisir le nom de l'utilisateur (ecb) et le mot de passe donné sur la carte.
7. Cliquer sur Connexion

Il est alors possible, par exemple, de basculer du site local au site distant un ou plusieurs dossiers, par exemple :

Accès phpMyAdmin

L'activation de l'interface web phpMyAdmin pour un site Prestashop, WooCommerce ou Blog permet l'administration de la base de données associée via le navigateur.

Sur cette page ne sont affichés que les sites Prestashop, WooCommerce et Blog démarrés car pour activer phpMyAdmin, le site associé doit obligatoirement être démarré.

Lorsque phpMyAdmin est activé pour un site, l'affichage est du type :

Une fois phpMyadmin activé, il sera possible d'accéder via le navigateur à la base de données du site.

Par exemple ici, pour le site blog-eleve2, phpMyAdmin sera accessible à l'adresse https://172.31.40.117:8800/pma-blogeleve2/.

Accès admin

Il s'agit d'un lien vers l'interface d'administration de Portainer. Ce lien n'est visible que pour les utilisateurs disposant des droits admin.

Fichier:OOjs UI icon notice-destructive.svg Avertissement :

Cette interface doit être utilisée avec une grande prudence car il est possible ici de supprimer les containers et les données d'un site sans aucune demande de confirmation ! L'application e-comBox peut également être supprimée !

Caractéristiques de chaque type d'application

Les identifiants d'accès

Les identifiants d'accès aux sites sont accessibles via l'interface de l'e-comBox.

Généralités sur les différentes applications

Application	Version	Commentaires
Prestashop	8.2.1	4 versions : deux e-boutiques opérationnelles, Art Concept Stories (300 références, 150 clients, 130 commandes) et Sweety Bio. Une boutique avec la version démo proposée par Prestashop ainsi qu'une version sans aucune données.
wooCommerce	6.8.0	2 versions : une e-boutique opérationnelle Art Concept Stories (300 références, 150 clients) et une boutique "squelette" totalement vierge.
Blog	6.8.0	Le module H5p est installé et activé.
Mautic	4.4.6	Mautic nécessite une configuration : voir ci-dessous le mode opératoire avec les éléments nécessaires.
Suite CRM	7.10.11
Odoo	12, 13, 14, 15, 16 et 17	Odoo comprend les modules les plus utilisés. D'autres modules peuvent être intégrés facilement via le SFTP. Intégration des bases primeur, surplomb, generik, pepiniere, ada, Sweety Bio
Kanboard	1.2.10	2 versions, une version "vierge" et une version personnalisée (BdDev)
Humhub	1.3.12

Configuration de Mautic

Mautic doit être configuré avec les éléments suivants :

Fichier:OOjs UI icon lightbulb-20 fc3.svg Note : Database Password : le mot de passe est donné sur l'interface au moment de la création du site.

Pour Basculer Mautic en français via l'interface graphique :

• roue dentée/configuration/system setting ;
• puis Apply ou Save & Close ;
• se reconnecter.

Fichier:OOjs UI icon lightbulb-20 fc3.svg Note : Il est possible de changer d'autres paramètres comme Default timezone.

Fichier:OOjs UI icon notice-destructive.svg Avertissement : Les paramètres de Mautic AdresseIP:port ne change jamais dans Configuration/paramètres généraux (même en cas de changement d'adresse IP) mais cela n'entraîne pas d'effets de bords et l'application continue de fonctionner normalement.

Aide

En cas de besoin les liens suivants sont mis à disposition dans la page Aide :

• documentation en ligne ;
• FAQ ;
• plateforme de support pour déclarer un incident avec un mode opératoire.