« E-comBox:Main Page » et « Migration vers la v4 » : différence entre les pages

De Documentation e-comBox
(Différence entre les pages)
 
Aucun résumé des modifications
 
Ligne 1 : Ligne 1 :
{{ProjectInfobox
{{note |La migration a été testée mais on ne sait jamais. '''Assurez-vous de disposer d'une sauvegarde de la v3 (script /opt/e-comBox/sauv_sites.sh)'''.|warn}}
|name = Projet e-comBox
|summary = L’application e-comBox est une application Web, utilisant la technologie des conteneurs Docker, installable uniquement sur Linux pour la version 4.
|members = Christelle Thiry, Cécile Pignon-Nivaggioni, Apollonie Raffalli, étudiants du BTS SIO du Lycée Laetitia Bonaparte à Ajaccio, équipes du réseau Certa.
}}


L’application e-comBox permet d'installer le plus simplement possible, au sein d'un réseau d'établissement, sur un portable personnel ou chez un hébergeur en ligne (serveur OVH par exemple), plusieurs instances de différentes applications (prestashop, wordpress, mautic, odoo, kanboard, etc) sous forme de conteneurs docker : les serveurs pourront être créés à la demande en tant que de besoin. L’idée est ici de répondre aux besoins pédagogiques les plus étendus des enseignants tout en réduisant les contraintes techniques au minimum.
== Migration vers la 4.1 ==
<br>
'''En tant qu'administrateur et sans avoir désinstallé la V3 :'''
<br>
# Modifier la valeur de la variable "BRANCHE" dans le fichier ''/opt/e-comBox/configure_application.sh'' : remplacer "'''v3'''" par "'''4.1'''".
''L’application e-comBox est elle-même une application web “dockérisée” installable sur n’importe quel système d’exploitation (Windows 10, Linux et MacOS) qui permet de lancer et gérer le ou les conteneurs dans lesquels le service est installé.''
# Ajouter "$@" après "start_configure_application.sh" : bash start_configure_application.sh "$@"
<br>
# Lancer la commande : <pre>bash /opt/e-comBox/configure_application.sh -p "votre_mdp_portainer"</pre>
<br>
Des scripts sont fournis pour les systèmes Linux (Debian et Ubuntu) pour installer l'application.


{{note | la version 4 permet le déploiement de l'e-comBox à grande échelle dans les académies et dans les régions. Elle est disponible uniquement sur Linux.}}
== Migration vers la 4.0 ==


Une instance de l'application est installée sur '''un seul poste (ou serveur)''', l'interface d'administration et les sites créés sont ensuite accessibles à distance via n'importe quelle machine.
<br>


{{note | L’application est livrée sous la '''licence CeCILL''' (Acronyme pour Ce(A)C(nrs)I(NRIA)L(ogiciel)L(ibre)) soumise au droit français et respectant les principes de diffusion des logiciels libres. Vous pouvez utiliser, modifier et/ou redistribuer ce programme sous les conditions de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA sur le site [https://www.cecill.info/ https://www.cecill.info/]|reminder}}
'''En tant qu'administrateur et sans avoir désinstallé la V3 :'''
<br>
# Modifier la valeur de la variable "BRANCHE" dans le fichier ''/opt/e-comBox/configure_application.sh'' : remplacer "'''v3'''" par "'''v4'''".
# Lancer la commande : <pre>bash /opt/e-comBox/configure_application.sh</pre>


'''Une vidéo de présentation est disponible''' : https://www.reseaucerta.org/pgi/e-combox
{{note|Le script détecte qu'une version 3 de l'e-comBox est installée, vous informe qu'une migration des sites est nécessaire mais sans danger d'autant plus qu'une sauvegarde des anciens sites a été réalisée et propose de poursuivre.}}
<br>


{{note| Pour tout problème rencontré avec l’utilisation de la e-comBox ou son installation vous devez créer un compte sur le support dédié (http://llb.ac-corse.fr/ecomboxsupport/signup_page.php) et ajouter un nouveau ticket. Cela permet notament aux autres utilisateurs de la e-comBox d’avoir accès à la résolution des différents problèmes. Vous trouverez l’aide pour l’utilisation du support [[Contactez_le_support|ici]].
Lors de la création de ce ticket, il faut y ajouter les logs qui nous aideront à comprendre les causes de l'incident. Pour savoir où sont stockés les logs, vous pouvez vous référer à la [[FAQ - v4|FAQ]] |warn}}


==Nouveautés de la version 4==
Pour installer la V4 et répondre correctement aux questions posées, '''suivre le lien [[Installation sur Linux - v4|Installation sur Linux]].'''
La nouvelle version d'e-comBox est disponible ! Comme chaque incrémentation cette version apporte son lot de nouveautés et d'améliorations.


{{Note | Cette version n'est proposée que pour une installation sur Linux. Si vous désirez installer l'e-comBox sur un poste windows, il vous faudra installer la version 3. | error}}
Le script installe ensuite la V4 puis migre (met à jour) les sites préalablement créés avec la V3. '''La migration peut prendre du temps.'''


Les principales nouveautés de cette version sont :
{{note | Un dossier ''migration'' est créé dans ''/opt/e-comBox'' dans lequel on trouvera tous les logs relatifs à la migration | reminder}}.
*La possibilité d'utiliser un reverse-proxy externe.
*La gestion de comptes utilisateurs (les professeurs ne voient et ne peuvent agir que sur les sites qu'ils ont eux-mêmes créés).
*Intégration du protocole HTTPS.
*Utilisation d'un seul port (qui peut être celui classiquement utilisé pour HTTPS) même si on n'installe pas de Reverse Proxy externe.
*Installation de l'e-comBox sans intervention de l'administrateur.
*Déploiement automatisé : exemple de script et de documentation pour un déploiement via Ansible.
*Gestion optimisée et facilitée des certificats avec un script permettant de générer un certificat avec letsEncrypt.
*Partage de ses propres modèles de sites : le partage de modèles de sites sera possible directement à partir de l'interface e-comBox après avoir créé un compte sur la plateforme Docker Hub.
*Récupération d'un modèle de site créé par un utilisateur de la communauté : il sera désormais possible, à partir du nom complet du modèle, de créer un site à partir d'un modèle partagé par un utilisateur de la communauté e-comBox.
*Actions sur les sites : possibilité de réaliser une action (supprimer, stopper, démarrer) sur plusieurs sites en les sélectionnant.
*Accès aux identifiants de connexion des différents sites directement à partir de l'interface d'e-comBox.


Les scripts utilisés sont disponibles sur gitlab :https://gitlab.com/e-combox/e-comBox_scriptsLinux.
{{note|'''Le premier démarrage des sites peut être long car une nouvelle image doit être téléchargée.'''}}
 
{{note | Les scripts ont été testés sur les versions Linux (obligatoirement 64 bits) suivantes :
* Ubuntu (à partir la version 18.04) ;
* Debian 9 ;
* Debian 10 ;
* Debian 11 (actuellement stable). | reminder}}
 
==Fonctionnalités de l’e-comBox==
[[File: MenuDetailleV3.png|180px|droite]]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 :
**versions 12, 13 et 14,
**cinq instances personnalisées : primeur, surplomb, pépinières, adA et Generik;
*Kanboard (gestion de projet) :
**une instance vierge,
**une instance personnalisée (BdDev) ;
*HumHub (réseau social).
'''La gestion de base''' permet de :
*lister les types de sites (Wordpress, prestashop, etc.) à partir desquels il est possible de créer un ou plusieurs sites ;
*créer, démarrer, arrêter ou supprimer un site ;
*lister les sites créés (avec l’état pour chacun et son URL d’accès au backoffice) ;
*créer un modèle à partir d'un site créé et personnalisé.
'''La gestion avancée''' permet l’accès :
*SFTP aux sites Prestashop et Wordpress ;
*via phpMyAdmin aux bases de données des sites Prestashop et Wordpress ;
*“admin” à l’interface de Portainer ;
*gérer les modèles de sites créés (visualisation, suppression, récupération et partage).
 
==Quatre types d'installation pour l'e-comBox==
L'installation peut se faire sur :
*'''un poste de l'établissement''' ;
*'''un serveur de l'établissement''' ;
*'''un serveur dans le cloud''' ;
*'''le poste personnel du professeur'''.
{{note|Pour une installation sur Linux, '''c'est le serveur qui est sur Linux''', l'ordinateur du professeur peut être sur n'importe quel système d'exploitation. Il accède à l'interface de l'e-comBox '''à distance''' avec un navigateur.}}
L'accès via un navigateur à l'interface de l'e-comBox peut évidemment se faire à distance.
<br>
Pour des raisons de commodité, il sera fait l’usage de “git” (le script l’installe) pour récupérer des fichiers sur les [https://gitlab.com/e-combox dépôts officiels ''gitlab''] de l’application.
 
==Caractéristiques minimum de la machine==
'''L'application nécessite au minimum :'''
*Linux : distribution basée sur Linux 64 bits comme Debian 9/10 ou Ubuntu à partir de la version 18.04 ;
*la virtualisation activée dans le BIOS (ce qui est fait, en règle générale, par défaut) ;
*la fonction SLAT supportée au niveau du processeur ;
*une connexion Internet de qualité ;
*8 Go de RAM : plus il y a de RAM, mieux c'est, pour notamment faire démarrer les sites en même temps ;
*le service Docker avec “docker-compose” (le script se chargent de l’installer) ;
 
<br>
{{note|8 Go de RAM est réellement un minimum, il ne faudra pas espérer faire tourner plus de 20 sites en même temps et vous risquez de rencontrer certaines lenteurs.
<br/>
Pour un '''serveur Linux''' devant héberger plusieurs sites pour deux classes de 32 élèves, il est conseillé de disposer d'au minimum 16 Go de RAM. |warn}}
 
==Ports utilisés==
Les ports 8880, 8888, 8800 et 5443 sont utilisés par défaut pour l'application elle-même. Ils doivent être libres. Si ce n'est pas le cas, vous devrez spécifier d'autres ports lors de l'installation de la e-comBox. Dans cette version :
*Si vous n'installez pas de Reverse Proxy externe, par défaut seul le port 8800 est exposé, vous pouvez le fixer à 443 (PORT_RP=443) de manière à ce que l'interface, Portainer et l'ensemble des applications soient accessibles directement (sans précision du port) via https.
*Si vous installez un Reverse Proxy externe, c'est le port exposé par ce Reverse Proxy qui sera utilisé. Vous pouvez donc laisser les ports par défaut au niveau de l'application.

Version du 20 février 2023 à 18:07

La migration a été testée mais on ne sait jamais. Assurez-vous de disposer d'une sauvegarde de la v3 (script /opt/e-comBox/sauv_sites.sh).

Migration vers la 4.1

En tant qu'administrateur et sans avoir désinstallé la V3 :

  1. Modifier la valeur de la variable "BRANCHE" dans le fichier /opt/e-comBox/configure_application.sh : remplacer "v3" par "4.1".
  2. Ajouter "$@" après "start_configure_application.sh" : bash start_configure_application.sh "$@"
  3. Lancer la commande :
    bash /opt/e-comBox/configure_application.sh -p "votre_mdp_portainer"

Migration vers la 4.0

En tant qu'administrateur et sans avoir désinstallé la V3 :

  1. Modifier la valeur de la variable "BRANCHE" dans le fichier /opt/e-comBox/configure_application.sh : remplacer "v3" par "v4".
  2. Lancer la commande :
    bash /opt/e-comBox/configure_application.sh
Le script détecte qu'une version 3 de l'e-comBox est installée, vous informe qu'une migration des sites est nécessaire mais sans danger d'autant plus qu'une sauvegarde des anciens sites a été réalisée et propose de poursuivre.


Pour installer la V4 et répondre correctement aux questions posées, suivre le lien Installation sur Linux.

Le script installe ensuite la V4 puis migre (met à jour) les sites préalablement créés avec la V3. La migration peut prendre du temps.

Un dossier migration est créé dans /opt/e-comBox dans lequel on trouvera tous les logs relatifs à la migration

.

Le premier démarrage des sites peut être long car une nouvelle image doit être téléchargée.