Installation de l'e-comBox

Les scripts utilisés sont disponibles sur le gitlab de la Forge des communs numériques : https://forge.apps.education.fr/e-combox/e-comBox_scriptsLinux.

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.

Ports utilisés

Les ports 8880, 8800 et 5443 sont utilisés par défaut pour l'application elle-même.

D'autres ports peuvent être spécifiéslors de l'installation de la e-comBox.

s'il n'y a pas d'utilisation d'un Reverse Proxy externe, par défaut seul le port 8800 est exposé. Ce port peut être 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.

S'il y a utilisation d'un Reverse Proxy externe, c'est le port exposé par ce Reverse Proxy qui sera utilisé. Les ports par défaut au niveau de l'application peuvent être laissé tel quel.

Version à utiliser

version 4.3

Dossier de l'application

Création par Docker ou le script d'installation :

du dossier $USER/.docker ;

du fichier /$USER/.docker/config.json“

Les dossiers de l'application :

/opt/e-combox

/opt/ecombox/e-comboxportainer * /opt/ecombox/e-comboxreverseproxy

Installation : script configure_application.sh

installation automatique obligatoire

à partir du fichier à partir du fichier /opt/e-combox/param.conf

en ligne de commande :

en indiquant un fichier contenant les paramètres

en listant les paramètres

Installation via Assible possible

3 démarches possibles :

nouvelle installation : param.conf est téléchargé et rempli avec les options passés en paramètre en ligne de commande

mettre à jour le ficher param.conf et l'utiliser à l'installation avec éventuellement des compléments en ligne de commande
* mettre à jour le ficher param.conf et lancer script configure_application.sh sans option

Configuration d'une authentification OpenID Connect : variable de param.conf OAUTHENABLE doit être mis à true renseigner les paramètres indiqués à ici

Récupération du script

mkdir /opt/e-combox
curl -fsSL https://forge.apps.education.fr/e-combox/e-combox_scriptslinux/raw/4.3/configure_application.sh -o /opt/e-combox/configure_application.sh

1re installation

lancer au minimum comme paramètre le mot de passe le l'@IP privée.

Exemple

bash /opt/e-combox/configure_application.sh -i "172.xxx.yyy.zzz" -d "nom.domaine" -p "mdp_portainer"

</WRAP>

si le fichier Le script principal installlinuxecomBox.sh :

installe curl et jq ;

télécharge et lance le script installdockerdocker-compose.sh : installe docker et docker-compose ;

télécharge et lance le script configureapplication.sh qui configure l'application dans l'environnement voulu (gestion de l'adresse IP ou nom de domaine, du proxy, etc.) ;

supprime le script configureapplication.sh ;

? * le script ajoutauth.sh qui configure l'authentification à l'interface d'e-comBox ;

Script configure_application.sh

* télécharge et exécute le script **start\_configure\_applcation.sh** ;
* supprime le script **start\_configure\_application.sh** ;

installation automatique avec le script configure_application.sh.

Le script installe l'e-comBox à partir du fichier /opt/e-combox/param.conf (qui a été enrichi de nouveaux paramètres - voir ici) sans interaction avec l'utilisateur.

Le script configure_application.sh peut être exécuté :

en mettant en option sur la ligne de commande un fichier contenant les paramètres que l'on veut ajouter et/ou modifier,

directement les différents paramètres (comme le mot de passe de Portainer) ;

sans option sur la ligne de commande si les valeurs des paramètres du fichier param.conf conviennent.

L'e-comBox peut être installé via avec un outil de déploiement tel qu'Ansible (des exemples de playbook sont fournis).

Téléchargement du script principal :

wget https://gitlab.com/e-combox/e-comBox_scriptsLinux/raw/v3/install_linux_e-comBox.sh --output-document install_linux_e-comBox.sh

Exécution du script principal

bash install_linux_e-comBox.sh

Deux autres scripts seront téléchargés automatiquement et disponibles par la suite dans le dossier /opt/e-comBox :

le script changeconfig_ip.sh plus léger qui permet de reconfigurer l'environnement en cas de modification de l'adresse iP du serveur et/ou du proxy ;

le script syncpwdportainer.sh qui permet de synchroniser un éventuel nouveau mot de passe du compte admin de Portainer.

Script start_configure_application.sh

Installe l'e-comBox

définit les ports réseau :

8888 : interface de l'application

8800 : accès aux sites

8880 : accès à l'interface d'administration de Portainer

configure éventuellement le proxy

configure par défaut le réseau d'e-comBox 192.168.97.0/24

lance le reverseproxy (/opt/e-comBox/ecomBoxreverseproxy/.env) avec les images library/nginx ; reseaucerta/docker-gen

définit les URL des sites sous la forme : http://@ipecombox:8800/nomdusite

lance le registry : image library/registry avec le nom e-comboxregistry

lance un serveur git : image reseaucerta/git-http-server

installe Portnainer : image reseaucerta/portainer-proxy, portainer/portainer-ce qui est accessible à l'URL http://@IP:8880/portainer

installe et configure e-comBox : image reseaucerta/-combox
* télécharge le fichier contenant les identifiants d'accès et les scripts permettant de reconfigurer l'application à /opt/e-comBox/e-comBox_identifiantsaccesapplication.pdf

e-combox accessibel à l'URL http://@ip:8888

définition du mot de passe du compte admin