« Installation sur Linux - v4 » et « Premiers pas - v4 » : différence entre les pages

De Documentation e-comBox
(Différence entre les pages)
 
Aucun résumé des modifications
 
Ligne 1 : Ligne 1 :
[[Fichier:MenuGaucheV4.png|droite|692x692px]]
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 vierge,
** une instance personnalisée (site Art Concept Stories) ;
* 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 et 14 :
** 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).
{{doc-important|Depuis la version 3, il est également possible de créer des sites à partir d'une image personnalisée.}}
<br>
{{note | L'installation de l'e-comBox est documentée pour [[Installation_sur_Linux_-_v4|Linux]]. Il n'est pas possible d'installer la version 4 sur Windows ou MacOS. | reminder}}


{{note | La '''version 4.1''' est sortie avec [https://gitlab.com/e-combox/e-combox_webapp/-/blob/4.1.0/CHANGELOG.md lot de nouveauté]. C'est celle-ci qu'il faut installer et n'hésitez pas à migrer si vous utilisez une version plus ancienne. | reminder}}
{{note|La version 4 nécessite de se connecter via un compte "Prof". Voir [[Gestion_Utilisateurs|ici]] le mode opératoire.}}


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


Les scripts utilisés sont disponibles sur gitlab : [https://gitlab.com/e-combox/e-comBox_scriptsLinux/-/tree/4.1 https://gitlab.com/e-combox/e-comBox_scriptsLinux].
* 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,


{{note | Les scripts ont été testés sur les versions Linux (obligatoirement 64 bits) suivantes :
et d'une zone principale qui s'adapte en fonction de l'élément de menu sélectionné :
* Ubuntu (à partir la version 18.04) ;
[[Fichier:Accueil v4.png|centré|900x900px]]
* Debian 9 ;
Le tableau de bord permet d'avoir une vue d'ensemble sur :
* Debian 10 ;
* la version de l'e-comBox ;
* Debian 11 (actuellement stable). | reminder}}
* 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.
[[Fichier:Dashboard v4.png|centré|900x900px]]


{{Note | Vous pouvez installer une ou plusieurs instances de l'e-comBox derrière un Reverse Proxy externe. Pour configurer ce dernier, consultez le "[https://gitlab.com/e-combox/e-comBox_scriptsLinux/-/blob/v4/README.md readme]" sur Gitlab.|warn}}
== 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.


{{Note | L'exécution des scripts doivent se faire en '''administrateur''' qui est "root" sur Linux (ou en utilisant la commande sudo).|error}}
=== Créer un site ===


{| class="wikitable"
Pour créer un site, il suffit de saisir un complément de nom pour le site puis cliquer sur le bouton ''créer'' (ou valider directement avec la touche "entrée" du clavier) :
|-
! '''Préalable, en cas de proxy pour curl et git'''
|-
|Définition des variables d'environnement nécessaires à l'exécution de commandes curl via un proxy :
* <span class="c2">export http_proxy="&lt;IPproxy&gt;:&lt;port&gt;"</span>
* <span class="c2">export https_proxy=$http_proxy</span>
|}


À noter également que si l'installation de Docker ne le fait pas le script de configuration crée le dossier "$USER/.docker" et le fichier /$USER/.docker/config.json".


== Installation de la version 4.1 ==
[[File:DocUtilisateur-images-image22.png|1000px|centre]]


=== Principe de fonctionnement ===
[[File:DocUtilisateur-images-image16.png|400px|droite]]
Il s'agit d'une installation automatique. Le script installe l'e-comBox à partir du fichier  /opt/e-comBox/param.conf (qui a été enrichi de nouveaux paramètres) sans interaction avec l'utilisateur.
Au clic du bouton ''créer'' (ou après avoir validé via la touche "entrée"), vous pouvez choisir de créer plusieurs sites.
<br>
<br>
Si vous laissez par défaut, un seul site sera créé et le nom du site sera de la forme : '''''type de site-complément de nom'''''.
Par exemple ici le nom sera '''''blog-01'''''.


Le fichier /opt/e-comBox/param.conf sera automatiquement rempli avec les éléments passés en ligne de commande ou avec un fichier /opt/e-comBox/param.conf existant (éventuellement issu d'une ancienne version). Si ce dernier n'existe pas déjà il sera créé.
{{note|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.}}
 
<br>
{{note|Les scripts install_linux_e-combox.sh et configure_application.sh peuvent être exécutés en mettant en paramètre un fichier contenant les paramètres que l'on veut modifier ou passer directement (avec des options) les paramètres sur le ligne de commande.<br>
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.
 
[[File:DocUtilisateur-images-image17.png|300px|centre]]
Cela peut également être très utile pour configurer chaque instance avec un outil de déploiement tel qu'Ansible (des exemples de playbook sont fournis).|reminder}}
<br>
 
{{note|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.}}
{{note | En ce qui concerne les certificats, si l’on passe par un reverse-proxy externe, les certificats de ce dernier sont propagés et il n’est pas besoin de les installer sur les instances (vous pouvez donc laisser le certificat se créer automatiquement comme proposé dans le script).<br>
 
Si vous ne passez pas par un reverse-proxy externe et que vous n'avez pas de certificat, il sera créé un certificat auto-signé mais il est aussi possible d'utiliser le script ''manage_certificat.sh'' pour générer un certificat Let's Encrypt pour votre domaine".}}
 
=== Le nouveau fichier param.conf ===
<pre>
#!/bin/bash
 
# Définition des paramètres utiles à l'application.
 
# Version du fichier paramètre (ne pas changer la valeur).
VERSION_PARAM="4.1.0"
 
# Validation (ou non) de la licence.
# Si cette variable n'a pas la valeur "true", l'application ne pourra pas être installée.
# La licence est consultable ici : https://gitlab.com/e-combox/e-comBox_scriptsLinux/-/raw/v4/LICENCE.
# Les conditions plus générales de la licence CeCILL sont définies sur le site : http://www.cecill.info.
VALIDATION_LICENCE="true"
 
# Mot de passe pour la connexion en admin à e-comBox et Portainer.
# Le mot de passe doit contenir au moins de 12 caractères sans espace.
# Le mot de passe ne doit pas contenir les caractères spéciaux suivants : \ " `
# Il ne peut pas être égal à "portnairAdmin" qui est connu de tous
# Le système met le mot de passe à jour avec celui saisi si les deux conditions suivantes sont réunies
# 1 - À l'installation ou à la réinitialisation de l'application
# 2 - Si le mot de passe renseigné a été au préalable modifié sur Portainer
# Ce mot de passe en clair sera chiffré, puis supprimé à l'installation, à la réinitialisation ou à la reconfiguration de l'application
# C'est donc normal qu'une fois l'application installée, réinitialisée ou mise à jour, ce paramètre apparaisse vide.
MDP_PORTAINER=""
 
# Adresse IP privée ou nom de domaine correspondant à une adresse IP privée.
# Si vous saisissez un nom de domaine, celui-ci doit pouvoir être résolu.
# Si aucun domaine n'est configuré, les sites seront accessibles à partir du réseau local via cette adresse IP privée.
# L'adresse IP privée doit obligatoirement être configurée même si le paramètre suivant est renseigné.
ADRESSE_IP_PRIVEE=""
 
# Adresse IP publique ou nom de domaine correspondant à une adresse IP publique.
# Si vous saisissez un nom de domaine, celui-ci doit pouvoir être résolu.
# Il s'agit du nom de domaine ou de l'adresse IP qui sera utilisée pour la connexion à l'interface, à Portainer et aux sites à la place de l'adresse IP privée.
# Aucune valeur ne doit donc être saisie ici si vous ne voulez pas cela, notamment si le serveur ne doit pas être accessible de l'extérieur.
DOMAINE=""
 
# Utilisation d'un Reverse-Proxy externe configuré par vos soins - O/N (N par défaut).
# Si vous passez par un reverse proxy externe, mettre "O".
# Les minuscules sont également acceptées.
RP_EXT="N"
 
# Chemin d'accès éventuel (en cas d'utilisation d'un Reverse-Proxy externe).
# Ne pas mettre de "/" dans le chemin.
CHEMIN=""
 
# Dossier en chemin absolu contenant la clé secrète qui chiffre le mot de passe de Portainer.
# Par défaut /opt/e-comBox, il est conseillé de le modifier.
# En cas de modification après installation, ne pas oublier de déplacer le fichier contenant la clé secrète.
DOSSIER_MDP_KEY="/opt/e-comBox"
 
# Dossier en chemin absolu contenant le mot de passe chiffré.
# Par défaut /opt/e-comBox, il est conseillé de le modifier.
# En cas de modification après installation, ne pas oublier de déplacer le fichier contenant le mot de passe chiffré.
DOSSIER_MDP_CHIFFRE="/opt/e-comBox"
 
# Port utilisé pour un accès direct à Portainer (8880 par défaut).
# Ce port n'a vocation à n'être utilisé qu'en cas de dépannage si l'accès via le reverse-proxy est impossible.
PORT_PORTAINER="8880"
 
# Port utilisé pour l'accès à Portainer, à l'interface et aux sites (8800 par défaut).
# Il s'agit du seul port exposé.
# Si aucun service Web n'écoute sur le port 443 de votre serveur, ce dernier peut être utilisé.
PORT_RP="8800"
 
# Port utilisé pour le registry (5443 par défaut).
PORT_REGISTRY="5443"
 
# Adresse du Proxy.
# Saisissez ip-proxy:port.
ADRESSE_PROXY=""
 
# Hôtes à ignorer par le proxy.
# Ce paramètre n'est à renseigner que si une adresse de Proxy a été saisie.
# Saisissez le ou les hôtes séparés par une virgule sans espace.
NO_PROXY=""
 
# Adresse du réseau interne à Docker.
# Si ce n'est pas votre première installation de l'application, le réseau a déjà été crée et affecté aux sites existants.
# Si vous modifiez les paramètres de ce réseau, TOUS LES SITES EXISTANTS SERONT SUPPRIMÉS.
NET_ECB="192.168.97.0/24"
 
# Suppression des images non associées à un site en cours d'exécution (true par défaut)
# Cela permet de gagner de l'espace mais aussi de supprimer des images qui ne seront plus jamais utilisées
# Le premier démarrage des sites sera un peu plus long car les images correspondantes devront être de nouveau téléchargées.
# Définir le paramètre à "false" si vous voulez ne voulez pas supprimer ces images (non conseillé lors d'une migration).
DEL_IMAGES="true"
 
# Les 2 variables qui suivent sont utiles pour donner le chemin vers les éléments pour mettre en place un certificat existant.
# Vous pouvez les laisser vides dans trois cas.
# Cas 1 : si vous passez par un reverse proxy externe, les certificats configurés dans ce dernier sont propagés.
# Cas 2 : l'accès à l'e-comBox ne va se faire que via le réseau local.
# Cas 3  vous ne disposez pas de certificat pour votre nom de domaine.
# À noter que le script manage_certificat.sh crée un certificat Let's Encrypt et permet de mettre à jour l'application
# si une des 6 variables qui suivent ont été modifiées
# Un certificat auto-signé se créera alors automatiquement via les 4 variables qui suivent.
 
# Fichier certificat existant avec le chemin complet /chemin/fichier.crt ou /chemin/fichier.pem.
CHEMIN_CERT=""
 
# Fichier de la clé privée existante correspondante au certificat avec le chemin complet /chemin/fichier.key.
CHEMIN_KEY=""
 
# Uniquement si utilisation de manage_certificat.sh pour créer un certificat Let's Encrypt
# Adresse de courriel non obligatoire pour créer le certificat (mais recommandé par Lets'encrypt)
MAIL=""
 
# Les 4 variables suivantes sont utiles pour créer un certificat auto signé.
# Elles sont utilisés pour le certificat du registry local.
# Elles sont également utilisées pour le reverse proxy (Nginx) si CHEMIN_CERT et CHEMIN_KEY sont vides.
# Même si vous avez un certificat existant, elles doivent obligatoirement être renseignées.
# Vous pouvez les modifier comme il vous convient.
 
# Code Pays sur 2 lettres.
CODE_PAYS="FR"


# Nom Pays.
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'' :
NOM_PAYS="France"
 
# Nom région.
NOM_REGION="Corse"
 
# Nom organisation.
NOM_ORGANISATION="ReseauCerta"
</pre>
 
=== Installation de l'e-comBox 4.1 ===
À noter qu'à partir de la version 4.1, il suffit de télécharger et d'exécuter le script configure_application.sh. Ce dernier installera Docker et Docker Compose s'ils sont inexistants sur le serveur.
<br>
<br>


'''1. Téléchargement du script configure_application.sh'''
[[File:Images13.png|900x900px|centre]]


Le téléchargement du script peut se faire à partir de la commande :
Pour créer plusieurs sites automatiquement, il suffit de donner un nom littéral au site et de choisir le nombre de sites que l'on veut créer (un numéro d'ordre s'incrémentera après le nom du site) :
<pre>wget https://gitlab.com/e-combox/e-comBox_scriptsLinux/raw/4.1/configure_application.sh --output-document configure_application.sh</pre>
[[Fichier:Creation 4 blogs.png|centré|900x900px]]
Quatre sites de noms "blog-eleve1" à "blog-eleve4" seront créés :
[[Fichier:Creation plusieurs sites.png|centré|900x900px]]




'''2. Exécution du script configure_application.sh'''
'''Pour les sites Prestashop et WooCommerce''', il est possible de créer 2 types de sites :
* '''vierge''' : site par défaut proposé par Prestashop et WooCommerce ;
* '''Art Concepts Stories''' : e-boutique opérationnelle (300 références, 150 clients, 130 commandes).


{{note | L'exécution du script doit se faire en '''administrateur''' qui est "root" sur Linux (ou en utilisant la commande sudo).}}
Il est donc nécessaire de choisir un type avant de cliquer sur le bouton ''créer'' :
<pre>
[[Fichier:Creation presta.png|centré|900x900px]]
Usage: bash configure_application.sh [-f "valeur"] [-i "valeur"] [-d "valeur"] [-r "valeur"] [-c "valeur"] [-p "valeur"] [s | b] [-h]
'''De même pour les sites Odoo''', il est possible de choisir entre les versions 12,13, 14 ou des images personnalisées :
  -f  Chemin vers le fichier de paramètre  [-f "/chemin/nom_fichier"]
[[Fichier:Creation odoo.png|centré|900x900px]]
  -i  Adresse IP privée ou nom de domaine correspondant à une adresse IP privée
=== Démarrer/arrêter un site ===
        [-i "@IP_PRIVEE" | -i "nom_domaine"]
  -d  Adresse IP publique ou nom de domaine correspondant à une adresse IP publique 
        [-d @IP_PUBLIQUE | -d nom_domaine].
        Pour supprimer une adresse IP publique ou un domaine existant -d ""
  -r  Passage par un Reverse-Proxy externe ou non  [-r "O" | -r "N"]
  -c  Chemin en cas de Reverse-Proxy externe [-c "chemin"]. Pour supprimer un chemin existant -c ""
  -p  Mot de passe de Portainer [-p "mot_de_passe"]
        Les caractères suivants " $ ` \ & | ! [space] ne peuvent pas être utilisés en ligne de commande
  -s  Met la variable de suppression des images à "true"  le temps d'exécution du script [-s]
  -b  Met la variable de suppression des images à "false" le temps d'exécution du script [-n]  
  -h  Détail des options
</pre>


'''Exemple d'exécution du script :'''
Un site démarré est affiché de la façon suivante :
<pre>
[[Fichier:Site demarre.png|centré|600x600px]]
bash /opt/e-comBox/configure_application.sh -i "192.168.10.1" -d "ecb.nom.domaine" -c "instance1" -r "O" -p "mdp_portainer"
Un clic sur le bouton bleu (interrupteur) permet alors d'arrêter le site. Un site stoppé est affiché de la façon suivante :
</pre>
[[File:Image2.png|600px|centre]]
Un nouveau clic sur l'interrupteur permet de le démarrer.<br>


Les valeurs des paramètres peuvent également être renseignées directement dans /opt/e-comBox/param.conf ou être passées (avec l'option "-f") via un fichier :
{{Warning/fr|msg=Le démarrage d'un site peut prendre quelques minutes car une mise à jour est réalisée automatiquement afin de prendre en compte la modification éventuelle de l'environnement d'e-comBox (en cas de changement de réseau par exemple).}}
<pre>
bash /opt/e-comBox/configure_application.sh -f "chemin_vers_fichier"
</pre>


'''Exemple de fichier :'''
=== Accéder à un site ===
<pre>
ADRESSE_IP_PRIVEE="172.31.40.109"
DOMAINE="ecb.nom.domaine"
RP_EXT="O"
CHEMIN="rne"
MDP_PORTAINER="mdp_portainer"
DOSSIER_MDP_KEY="/etc/ssl/certs/ecombox"
DOSSIER_MDP_CHIFFRE="/etc/ssl/certs/ecombox"
</pre>


{{note | tous les paramètres peuvent être modifiés via ce fichier. Dans l'exemple ci-dessus, les paramètres DOSSIER_MDP_KEY et DOSSIER_MDP_CHIFFRE seront également modifiés.}}
Pour accéder à un site, ce dernier doit être démarré.


{{note | En ce qui concerne le mot de passe de Portainer, <nowiki>Les caractères suivants " $ ` \ & | ! [space] ne peuvent pas être utilisés en ligne de commande. Si vous saisissez votre mot de passe dans le fichier param.conf, seuls les caractères spéciaux \ " et ` sont interdits</nowiki>.| warn}}
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é.


== Installation de la version 4.0 ==
'''Les URL peuvent être visualisées :'''


=== Principes de fonctionnement ===
* '''Au survol du lien ''Accéder au site'' :'''
[[Fichier:Affiche URL.png|centré|600x600px]]


'''Le script principal ''install_linux_ecomBox.sh'' installe l'outil "curl" et appelle 2 autres scripts :
* '''Au clic sur le bouton ''Afficher les URL'' :'''
* ''install_docker_docker-compose.sh'' : installe docker et docker-compose ;
[[Fichier:Btn affiche URL.png|centré|600x600px]]
* ''configure_application.sh'' : configure l'application e-combox.
{{Done|Le bouton Afficher les URL n'apparaît qu'à partir du moment où au moins un site est démarré.}} {{note|Les URL sont au format ''http://<hôte ou adresse IP d'ecomBox>:<port du proxy>/<nom-du-site>/<chemin-backoffice>''.
Par exemple, dans l'image ci-dessus, l'hôte est "llb.ac-corse.fr", le port du proxy est "11252" et le chemin vers le backoffice est "/wp-admin". '''Seuls les noms des sites changent (blog-01, blog-02, blog-03 et blog-04)'''.}}


Vous pouvez :
=== Exporter la liste des URL au format PDF ===
* soit exécuter le script principal ;
* soit récupérer et exécuter consécutivement les deux scripts.


Le script de configuration de l'application est interactif, il demande des informations et utilise un fichier de paramètres ''/opt/e-comBox/param.conf qui contient :
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'' :
* l'adresse IP privée du serveur (par défaut 127.0.0.1) ;
[[Fichier:Export pdf.png|centré|400x400px]]
* l'adresse IP publique ou le nom de domaine (si l'application doit être accessible de l'extérieur) ;
Le bouton ''Exporter'' permet de générer et d'ouvrir automatiquement un fichier PDF contenant cette liste :
* le chemin d'accès (en cas de passage par un Reverse Proxy externe) ;
[[Fichier:Pdf.png|centré|600x600px]]
* le numéro des quatre ports que l'application doit obligatoirement utiliser :
{{Note/fr|Les URL sur ce fichier PDF sont cliquables.}}
** Port utilisé pour l'interface de l'e-comBox, par défaut PORT_ECB=8888,
** Port utilisé pour Portainer, par défaut PORT_PORTAINER=8880,
** Port utilisé pour l'accès  aux sites, par défaut PORT_RP=8800 (c'est le seul port "utile", voir note ci-dessous)
** Port pour le registry, par défaut PORT_REGISTRY=5443 (ce port est interne et n'est pas exposé) ;
* l'adresse du proxy et hôtes à ignorer (si un proxy est nécessaire pour l'accès Internet);
* les variables nécessaires au certificat (à ne remplir qu'en cas de non utilisation de Reverse Proxy externe).


{{note | Le port du Reverse Proxy (PORT_RP) est le seul port non transparent pour les utilisateurs : c'est ce port qui est utilisé dans l'URL si on ne passe pas par le Reverse Proxy externe ou c'est vers ce port qu'il faudra rediriger dans la [https://gitlab.com/e-combox/e-comBox_scriptsLinux/-/blob/v4/README.md configuration du Reverse Proxy externe].}}
=== Supprimer un site ===


L'adresse IP et les configurations du proxy peuvent être modifiés interactivement via le script. Les ports doivent être modifiés dans le fichier "param.conf" avant de lancer le script.
Pour supprimer un site, il faut cliquer sur le bouton en haut à droite de la "carte" correspondante :
[[Fichier:Del site.png|centré|600x600px]]
{{Warning/fr|msg={{color|red|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é.
[[Fichier:Popup del.png|gauche|vignette]]
<br>Ce ''pop-up'' vous en averti en s'affichant en haut à droite de la page.<br>{{Note/fr|La carte associée disparaît alors de l'e-comBox.}}
<br clear=all>


{{note | Il est aussi possible de modifier l'adresse du réseau à utiliser pour les sites si celle par défaut ne convient pas au moment où cela est demandé. '''Cette dernière doit être différente de l'adresse réseau utilisée par l'établissement'''.| reminder}}
=== Dupliquer un site ===


=== Installation de l'e-comBox 4.0 ===
== Gestion avancée ==


'''1. Téléchargement du script principal'''
La gestion avancée permet :


Le téléchargement du script principal peut se faire à partir de la commande :
* d'accéder aux sources des sites Prestashop et Odoo ;
<pre>wget https://gitlab.com/e-combox/e-comBox_scriptsLinux/raw/v4/install_linux_e-comBox.sh --output-document install_linux_e-comBox.sh</pre>
* d'accéder aux bases de données des sites Prestashop, WooCommerce et Blog ;
* d'administrer directement les conteneurs : {{color|red|'''à utiliser avec prudence'''}}.


'''2. Exécution du script principal'''
=== Accès SFTP ===


{{note | L'exécution du script doit se faire en '''administrateur''' qui est "root" sur Linux (ou en utilisant la commande sudo).}}
L'accès SFTP permet d'accéder aux sources des sites Prestashop et Odoo.
<pre>bash install_linux_e-comBox.sh</pre>
[[Fichier:Accueil sftp.png|centré|900x900px]]
{{note|Sur cette page ne sont affichés que les sites Prestashop et Odoo démarrés car pour activer le SFTP, le site associé doit obligatoirement être démarré.}}


Pour exécuter le script en tant qu'administrateur :
Lorsque le SFTP est activé pour un site l'affichage est du type :
- '''''sudo bash install_linux_e-comBox.sh''''' et vous saisissez votre mot de passe ;
[[Fichier:Sftp active.png|centré|600x600px]]
- ou bien '''''sudo su''''' puis vous saisissez votre mot de passe et vous exécutez ensuite le script : '''''bash install_linux_e-comBox.sh'''''.
{{Note/fr|Une fois le SFTP activé, il est possible d'accéder aux sources dans un nouvel onglet à partir de l'URL  de l'hôte fournie 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).}}
[[Fichier:Connexion sftp.png|centré|600x600px]]
Voici par exemple un extrait du contenu des "addons" d'Odoo :
[[Fichier:Addons odoo.png|centré|900x900px]]
<br>Accès phpMyAdmin


Si l'installation ne le fait pas le script de configuration crée le dossier "$USER/.docker" et le fichier /$USER/.docker/config.json".
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.
[[Fichier:Accueil pma.png|centré|900x900px]]
{{note | 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é.}}


{{note | Les fichiers nécessaires à l'application, les scripts de reconfiguration de l'application ainsi que le fichier contenant les identifiants d'accès aux applications (''e-comBox_identifiants_acces_applications.pdf'') sont installés dans "/opt/e-comBox".|warn}}
Lorsque phpMyAdmin est activé pour un site l'affichage est du type :
[[Fichier:Pma active.png|centré|600x600px]]
{{Note/fr|Une fois phpMyadmin activé, il sera possible d'accéder via le navigateur à la base de données du site.}}  


Le script ''install_linux_ecomBox.sh'' lance automatiquement le script ''configure_application.sh''</span><span class="c2"> qui configure l'application dans l'environnement voulu (gestion de l'adresse IP ou nom de domaine, du proxy, etc.) ;
Par exemple ici, pour le site ''blog-eleve2,'' phpMyAdmin sera accessible à l'adresse https://172.31.40.117:8800/pma-blogeleve2/''.''


{{note | Si le serveur passe par un proxy, il faut être vigilant sur la configuration du "noproxy" : il est, en effet, nécessaire d'exclure dans la configuration du proxy "localhost" et le réseau dans lequel se trouve le serveur d'ecomBox ainsi que  le réseau dans lequel se trouve le proxy (si celui-ci est différent). Par exemple, si votre réseau local est 192.168.20.0/24, il faut ajouter dans les éléments d'exclusion 192.168.20.*. Il faut séparer les valeurs saisies par une virgule.|error}}
=== Accès admin ===


{{note | Dans cette version, au cours du script, il sera nécessaire de modifier le mot de passe '''admin''' de Portainer mais il n'y a plus de nécessité de le synchroniser avec l'application e-comBox. Un script permettant de réinitialiser ce mot de passe en cas de perte est disponible dans le dossier /opt/e-comBox.}}
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:Accueil portainer.png|centré|900x900px]]
{{Warning/fr|msg=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 ==


== Lancement de l'e-comBox et utilisation de base ==
=== Les identifiants d'accès ===


'''En cas de Reverse Proxy externe :'''
Les identifiants d'accès sont dans un fichier qui est installé par les scripts dans le dossier ''/opt/e-comBox.''
* L'interface de l'e-comBox sera accessible via l'URL : https://<nom_domaine>/<chemin>/app/
* L'interface de Portainer sera accessible via l'URL : https://<nom_domaine>/<chemin>/portainer/
* Les sites seront accessibles via un URL sous la forme : https://<nom_domaine>/<chemin>/nom_du_site/


'''S'il n'y a pas de Reverse Proxy externe :'''
=== Généralités sur les différentes applications ===
* L'interface de l'e-comBox sera accessible via l'URL : https://<adresse_IP ou nom_domaine>:PORT_RP/app/
* L'interface de Portainer sera accessible via l'URL : https://<adresse_IP ou nom_domaine>:PORT_RP/portainer/
* Les sites seront accessibles via un URL sous la forme : https://<adresse_IP ou nom_domaine>:PORT_RP/nom_du_site/


{{note|Si le nom de domaine est renseigné, c'est ce dernier qui est utilisé.}}
{| class="wikitable"
|-
! Application !! Version !! Commentaires
|-
| Prestashop
| 1.7.6.5
| 2 versions : une e-boutique opérationnelle ''Art Concept Stories'' (300 références, 150 clients, 130 commandes) et une boutique avec la version ''démo'' proposée par Prestashop.
|-
| wooCommerce
| 5.4.2
| 2 versions : une e-boutique opérationnelle ''Art Concept Stories'' (300 références, 150 clients) et une boutique "squelette" totalement vierge.
|-
| Blog
| 5.4.2
| Le module H5p est installé et activé.
|-
| Mautic
| 3
| 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 et 13
| Odoo n'intègre aucun site mais comprend les modules les plus utilisés. D'autres modules peuvent être intégrés facilement via le SFTP.
|-
| Kanboard
| 1.2.10
|Voir ci-dessous pour basculer l'interface graphique en français.
|-
| Humhub
| 1.3.12
|
|}


{{note|Si vous mettez le numéro de port 443 (il faut, bien sûr, qu'il soit libre) au niveau de la variable PORT_RP dans le fichier de configuration param.conf, l'interface de l'e-comBox sera accessible via HTTPS sans qu'il soit besoin de préciser le PORT_RP dans l'URL|reminder}}


 
==== Configuration de Mautic ====
Il faut donc lancer l'application en saisissant :
[[File:Image26.png|600px|droite]]
*l'URL '''https://<nom_domaine>/<chemin>/app/''' en cas de passage par un Reverse proxy externe ;
Mautic doit être configuré avec les éléments suivants :
*l'URL '''https://<adresse_IP ou nom_domaine>:PORT_RP/app/''' en cas de non passage par un Reverse Proxy externe.
<br>
 
<br>
{{note|L'authentification peut se faire avec le compte "admin" de Portainer ou avec un compte "professeur" préalablement créé dans Portainer. '''La gestion des utilisateurs est décrite [[Gestion_Utilisateurs|ici]].'''}}
{{note/fr}} Database Password : le mot de passe est donné sur l'interface au moment de la création du site.
 
<br>
La connexion à l'interface de l'application nécessite obligatoirement une authentification.
[[Fichier:Mautic.png|gauche|600x600px]]
[[Fichier:EcranAuthentificationEcomBox.png|centré|500x500px]]
{{note|Dans cette version, plusieurs comptes "professeurs" peuvent être créés et chaque professeur ne voit et ne peut agir que sur ses propres sites. Si vous ne disposez pas d'identifiants, il est nécessaire de contacter l'administrateur de votre instance.Par ailleurs, vous pouvez modifier votre mot de passe via l'interface.|reminder}}.
 
Lorsqu'on se connecte (après s'être authentifié), un tableau de bord simplifié permet d'avoir une vue d'ensemble :
[[Fichier:Interface ecb v4.1.png|centré|900x900px]]
<span class="c6">Un clic, dans le menu de gauche (par exemple sur Odoo) conduit à un écran similaire à ci-dessous :</span>
[[Fichier:Sites Odoo.png|centré|900x900px]]
<br clear=all>
<br clear=all>
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 [[Premiers_pas_-_v4|ici]].


{{Note/fr|type=reminder|Depuis la version 4.1, les identifiants de connexion aux sites sont disponibles à partir de l'interface.}}
Pour Basculer Mautic en français via l'interface graphique :
* roue dentée/configuration/system setting ;
* puis ''Apply'' ou ''Save &amp; Close'' ;
* se reconnecter.  


'''En cas de problème''' consultez la [[FAQ_-_v4 | FAQ]].{{note | 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 en exécutant de nouveau le script ''configure_application.sh'' avec de nouvelles options si nécessaire :
{{note/fr}} Il est possible de changer d'autres paramètres comme ''Default timezone''.
<pre>bash /opt/e-comBox/configure_application.sh [options] </pre> | error}}


== La gestion des ressources pour Docker ==
{{Warning/fr}} 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.


Sur Linux, le professeur sera juste limité par la capacité de son poste (capacité du disque, capacité du processeur et capacité de la mémoire) sachant que le processeur et la mémoire ne sont affectés que lorsque les sites sont lancés.
====Basculer Kanboard en français====


Par exemple, une instance de Prestashop sur Docker nécessite aux alentours de 200 MB de RAM.
Sur l'interface graphique :
# Aller dans la rubrique Application settings.
# Modifier la langue, le fuseau horaire et le format des dates.
# Enregistrer.


Le tableau de bord fournit des statistiques d'utilisation en temps réel.
== Aide ==
En cas de besoin les liens suivants sont mis à disposition dans la page ''Aide'' :
* [[E-comBox:Main_Page|documentation en ligne]] ;
* [[Trousse_de_premiers_secours|trousse de premiers secours]] ;
* [[FAQ - v4|FAQ]] ;
* [[Contactez_le_support|plateforme de support]] pour déclarer un incident avec un mode opératoire.

Version du 24 février 2023 à 00:35

MenuGaucheV4.png

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 vierge,
    • une instance personnalisée (site Art Concept Stories) ;
  • 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 et 14 :
    • 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).

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


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.

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é :

Accueil v4.png

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

  • la version 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.
Dashboard v4.png

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

Pour créer un site, il suffit de saisir un complément de nom pour le site puis cliquer sur le bouton créer (ou valider directement avec la touche "entrée" du clavier) :


DocUtilisateur-images-image22.png
DocUtilisateur-images-image16.png

Au clic du bouton créer (ou après avoir validé via la touche "entrée"), vous pouvez choisir de créer plusieurs sites.

Si vous laissez par défaut, un seul site sera créé et le nom du site sera de la forme : type de site-complément de nom. Par exemple ici le nom sera blog-01.

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.

DocUtilisateur-images-image17.png


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 :

Images13.png

Pour créer plusieurs sites automatiquement, il suffit de donner un nom littéral au site et de choisir le nombre de sites que l'on veut créer (un numéro d'ordre s'incrémentera après le nom du site) :

Creation 4 blogs.png

Quatre sites de noms "blog-eleve1" à "blog-eleve4" seront créés :

Creation plusieurs sites.png


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

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

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

Creation presta.png

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

Creation odoo.png

Démarrer/arrêter un site

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

Site demarre.png

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

Image2.png

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

Avertissement Avertissement : Le démarrage d'un site peut prendre quelques minutes car une mise à jour est réalisée automatiquement afin de prendre en compte la modification éventuelle de l'environnement d'e-comBox (en cas de changement de réseau par exemple).

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 :
Affiche URL.png
  • Au clic sur le bouton Afficher les URL :
Btn affiche URL.png

Yes Le bouton Afficher les URL n'apparaît qu'à partir du moment où au moins un site est démarré.

Les URL sont au format http://<hôte ou adresse IP d'ecomBox>:<port du proxy>/<nom-du-site>/<chemin-backoffice>. Par exemple, dans l'image ci-dessus, l'hôte est "llb.ac-corse.fr", le port du proxy est "11252" et le chemin vers le backoffice est "/wp-admin". Seuls les noms des sites changent (blog-01, blog-02, blog-03 et blog-04).

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 :

Export pdf.png

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

Pdf.png
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 :

Del site.png
Avertissement 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é.

Popup del.png


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.


Dupliquer un site

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 et Odoo.

Accueil sftp.png
Sur cette page ne sont affichés que les sites Prestashop 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 :

Sftp active.png
Une fois le SFTP activé, il est possible d'accéder aux sources dans un nouvel onglet à partir de l'URL de l'hôte fournie 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).
Connexion sftp.png

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

Addons odoo.png


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.

Accueil pma.png
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 :

Pma active.png
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.

Accueil portainer.png
Avertissement 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 sont dans un fichier qui est installé par les scripts dans le dossier /opt/e-comBox.

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

Application Version Commentaires
Prestashop 1.7.6.5 2 versions : une e-boutique opérationnelle Art Concept Stories (300 références, 150 clients, 130 commandes) et une boutique avec la version démo proposée par Prestashop.
wooCommerce 5.4.2 2 versions : une e-boutique opérationnelle Art Concept Stories (300 références, 150 clients) et une boutique "squelette" totalement vierge.
Blog 5.4.2 Le module H5p est installé et activé.
Mautic 3 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 et 13 Odoo n'intègre aucun site mais comprend les modules les plus utilisés. D'autres modules peuvent être intégrés facilement via le SFTP.
Kanboard 1.2.10 Voir ci-dessous pour basculer l'interface graphique en français.
Humhub 1.3.12


Configuration de Mautic

Image26.png

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

Note Note : Database Password : le mot de passe est donné sur l'interface au moment de la création du site.

Mautic.png


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

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

Note Note : Il est possible de changer d'autres paramètres comme Default timezone.

Avertissement 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.

Basculer Kanboard en français

Sur l'interface graphique :

  1. Aller dans la rubrique Application settings.
  2. Modifier la langue, le fuseau horaire et le format des dates.
  3. Enregistrer.

Aide

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

Récupérée de « https://wiki-ecombox.btssio.corsica/index.php?title=Installation_sur_Linux_-_v4&oldid=817 »