Installation sur Linux

De Support e-comBox

Préalables

Les scripts utilisés sont disponibles sur gitlab :https://gitlab.com/e-combox/e-comBox_scriptsLinux.

Note Note: Les scripts ont été testés sur :

  • Ubuntu (à partie la version 18.04) ;
  • Debian 9 ;
  • Debian 10 (actuellement stable).
Warning Warning: Il s'agit ici d'une installation sur un serveur ; ce dernier pourra être accessible de l'extérieur. Pour cette deuxième version, trois redirections de port sont nécessaires plus éventuellement les ports pour accéder aux sources via le protocole sftp (voir les détails dans la suite du document). Par ailleurs, les conteneurs sont sécurisés (les mots de passe ne sont pas écrits en clair dans les docker-compose de chaque type d'applications).

Le script principal install_linux_ecomBox.sh installe l'outil "curl" et appelle 2 autres scripts :

  • install_docker_docker-compose.sh : installe docker et docker-compose ;
  • configure_application.sh : configure l'application e-combox.

Vous pouvez :

  • soit exécuter le script principal ;
  • soit récupérer et exécuter consécutivement les deux scripts.
Warning Warning: L'exécution des scripts doivent se faire en administrateur qui est "root" sur Linux (ou en utilisant la commande sudo).
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 :
  • export http_proxy="<IPproxy>:<port>"
  • export https_proxy=$http_proxy

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 :

  • l'adresse IP privée et/ou publique ou nom de domaine (si l'application doit être accessible de l'extérieur) ;
  • le numéro des trois ports que l'application doit obligatoirement utiliser ;
  • l'adresse du proxy et hôtes à ignorer (si un proxy est nécessaire pour l'accès Internet).

Les valeurs proposées par défaut sont les suivantes :

# Adresse IP ou nom du domaine pleinement qualifié
ADRESSE_IP=127.0.0.1

# Port utilisé pour l'interface d'e-comBox
PORT_ECB=8888

# Port utilisé pour Portainer
PORT_PORTAINER=8880

# Port utilisé pour l'accès  aux sites
PORT_RP=8800

# Adresse du Proxy
ADRESSE_PROXY=

# No Proxy
NO_PROXY=

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.

Note 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é.

Installation de l'e-comBox

1. Téléchargement du script principal

Le téléchargement du script principal peut se faire à partir de la commande :

wget https://gitlab.com/e-combox/e-comBox_scriptsLinux/raw/master/install_linux_e-comBox.sh 

2. Exécution du script principal

Warning Warning: L'exécution du script doit se faire en administrateur qui est "root" sur Linux (ou en utilisant la commande sudo).
bash install_linux_e-comBox.sh
Pour exécuter le script en tant qu'administrateur :
- sudo bash install_linux_e-comBox.sh et vous saisissez votre mot de passe ;
- ou bien sudo su puis vous saisissez votre mot de passe et vous exécutez ensuite le script : bash install_linux_e-comBox.sh.

Si l'installation ne le fait pas le script de configuration crée le dossier "$USER/.docker" et le fichier /$USER/.docker/config.json".

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

Le script install_linux_ecomBox.sh lance automatiquement :

  • le script configure_application.sh qui configure l'application dans l'environnement voulu (gestion de l'adresse IP ou nom de domaine, du proxy, etc.) ;
  • le script ajout_auth.sh qui configure l'authentification à l'interface d'e-comBox ;

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

  • le script change_config_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 sync_pwd_portainer.sh qui permet de synchroniser un éventuel nouveau mot de passe du compte "admin" de Portainer.


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

Configuration éventuelle de l'adresse IP publique ou du nom de domaine

Si vous voulez que l'e-comBox soit accessible d'Internet, il faut donner au script (quand il le demande) l'adresse IP publique ou le nom de domaine ou bien saisir cette adresse IP ou ce nom de domaine dans le fichier "param.conf".

Pour que l'e-comBox fonctionne ensuite, il est nécessaire de configurer le NAT/PAT et rediriger les ports 8888 (pour l'accès à l'application) et 8880 (pour l'accès à l'administration avancée) et 8800 (pour l'accès au sites) vers l'adresse IP privée.

Note Note: Pour une utilisation du SFTP, il est également nécessaire de rediriger les ports allant de 2200-2249 (pour Prestashop) et 2250-2299 (pour Odoo).

Lancement de l'e-comBox et utilisation de base

Il faut lancer e-comBox en saisissant l'URL http://adresse_ip:8888 dans un navigateur.

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 en exécutant le script change_config_ip.sh :

bash change_config_ip.sh

En cas de problème consultez :

Connexion à l'interface

DocEcomBox/images/image9.png

Lorsqu'on se connecte (après éventuellement s'être authentifié), 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é :
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.

La gestion des ressources pour Docker

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.

Par exemple, une instance de Prestashop sur Docker nécessite aux alentours de 200 MB de RAM.

Le tableau de bord fournit des statistiques d'utilisation en temps réel.