2025-04-26T01:43:57Z

Aporaf : /* Le nouveau fichier param.conf (dans sa version 4.4) */

{{note|La '''version 4.4''' est la dernière version. Voir le [[https://forge.apps.education.fr/e-combox/e-combox_documentation/-/blob/4.4/CHANGELOG.md?ref_type=heads|changelog]]|reminder}}

== Préalables ==

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/-/blob/4.4/README.md?ref_type=heads https://forge.apps.education.fr/e-combox/e-comBox_scriptsLinux].

{{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
* Debian 12 (actuellement stable).|reminder}}

Vous pouvez installer une ou plusieurs instances de l'e-comBox derrière un Reverse Proxy externe. Pour configurer ce dernier, consultez la documentation sur la [[https://forge.apps.education.fr/e-combox/e-combox_documentation/-/blob/4.4/installation.md?ref_type=heads#exemples-de-configuration-dun-reverse-proxy|Forge]].

{{Note|L'exécution des scripts doit se faire avec un compte '''administrateur''' (éventuellement en utilisant la commande '''sudo su'''.|error}}

{| class="wikitable"
|-
! '''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
|}

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

{{Note/fr|type=warn|À partir de la version des scripts 4.1.1 (20/04/2023), tous les "B" majuscule dans les noms de dossier basculent en "b" minuscule :
- le dossier d'installation /opt/e-comBox devient /opt/e-combox
- le dossier /opt/ecomBox/e-comBox_portainer devient /opt/ecombox/e-combox_portainer
- le dossier /opt/ecomBox/e-comBox_reverseproxy devient /opt/ecombox/e-combox_reverseproxy
...}}

== Mise à jour de l'e-comBox==

Si vous disposez déjà au minimum d'une version 4.1, la mise à jour est très simple :

1. Télécharger la dernière version du script :
<pre>wget https://forge.apps.education.fr/e-combox/e-combox_scriptslinux/raw/4.4/configure_application.sh --output-document configure_application.sh</pre>

2. Lancer la commande :
<pre>bash configure_application.sh</pre>

{{Note/fr|type=reminder|Le script récupère tous les autres paramètres dans votre ancien fichier /opt/e-comBox/param.conf. D'autres paramètres (non obligatoires) ont été ajoutés pour pouvoir bénéficier de certaines autres fonctionnalités.}}

== Installation de la version 4.4 ==

=== Principe de fonctionnement ===
L'installation se réalise avec le script configure_application.sh. '''Il s'agit d'une installation automatique''' qui installe tous les composants nécessaires. Le script installe l'e-comBox à partir du fichier /opt/e-combox/param.conf (qui a été enrichi de nouveaux paramètres - voir [[Installation sur Linux - v4#Le nouveau fichier param.conf (dans sa version 4.4)|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,
** les différents paramètres (comme le mot de passe de Portainer avec -p mot_de_passe) ;
* sans option sur la ligne de commande si les valeurs des paramètres du fichier /opt/e-combox/param.conf conviennent.

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

{{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 nécessaire de les installer sur les instances (vous pouvez donc laisser le certificat se créer automatiquement comme proposé dans le script). 

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

{{note|À partir de la '''version 4.2''' il est possible de '''configurer une authentification OpenID Connect'''. Pour cela, la variable de param.conf OAUTH_ENABLE doit être mis à "true" et les paramètres suivants renseignés (voir [[Usage des scripts - v4#Configuration de l'authentification openID Connect : configure oauth.sh (version 4.2)|ici]])}}
{{note|À partir de la '''version 4.4''' il est possible de :
* créer des sites via le script "manage_sites.sh" ;
* de remplacer les identifiants par défaut des administrateurs des Prestashop, WordPress et Odoo par le couple mail de l'élève/mot de passe généré aléatoirement.
Pour cela, les variables concernant la configuration d'un serveur SMTP doivent être renseignées dans le fichier param.conf de manière à ce que les identifiants soient envoyés par mail.}}

=== Installation de l'e-comBox 4.4 ===
{{note|[https://forge.apps.education.fr/e-combox/e-combox_documentation/-/blob/4.4/installation.md?ref_type=heads#exemples-de-configuration-dun-reverse-proxy Une documentation sur la configuration d'un reverse-proxy externe], utile en cas de plusieurs instances derrière un même nom de domaine, figure sur la Forge.|reminder}}

'''1. Téléchargement du script configure_application.sh'''

Le téléchargement du script peut se faire à partir de la commande :
<pre>wget https://forge.apps.education.fr/e-combox/e-comBox_scriptsLinux/raw/4.4/configure_application.sh --output-document configure_application.sh</pre>

'''Pour vous simplifier la tache''' vous allez peut-être avoir besoin de télécharger également le fichier param.conf (voir exemple 4) qu'il suffira de compléter avec les principaux paramètres :<pre>wget https://forge.apps.education.fr/e-combox/e-comBox_scriptsLinux/raw/4.4/param.conf --output-document param.conf</pre>

'''2. Exécution du script configure_application.sh'''

{{note|L'exécution du script doit se faire en '''administrateur''' qui est "root" sur Linux (ou en utilisant la commande "sudo su" pour avoir une console "root").}}
<pre>
Usage: bash configure_application.sh [-f "valeur"] [-i "valeur"] [-d "valeur"] [-r "valeur"] [-c "valeur"] [-p "valeur"] [s | b] [-h]
-f Chemin vers le fichier de paramètre [-f "/chemin/nom_fichier"]
-i Adresse IP privée ou nom de domaine correspondant à une adresse IP privée
[-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>

Il existe plusieurs possibilités d'exécution du script, ci-dessous quelques exemples.

'''Exemple 1''' :
<pre>
bash configure_application.sh -i "172.31.40.109" -d "ecb.nom.domaine" -c "rne" -r "O" -p "mdp_portainer"
</pre>

L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.109".

Le domaine est "ecb.nom.domaine" et l'interface de l'e-comBox sera accessible via un Reverse Proxy externe. En l'espèce https://ecb.nom.domaine/rne/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 2''' :
<pre>
bash configure_application.sh -i "172.31.40.111" -p "mdp_portainer"
</pre>

L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.111".

L'interface de l'e-comBox sera accessible uniquement à partir de l'adresse IP privée sur le port 8800 défini par défaut dans le fichier param.conf. En l'espèce https://172.31.40.111:8800/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 3''' :
<pre>
bash configure_application.sh -i "172.31.40.121" -d "ecb.nom.domaine" -p "mdp_portainer"
</pre>

L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.121".

L'interface de l'e-comBox sera accessible à distance sur le port 8800 défini par défaut dans le fichier param.conf mais sans passage par un reverse-proxy externe. En l'espèce https://ecb.nom.domaine:8800/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 4''' :
<pre>
bash configure_application.sh -f "chemin_vers_fichier"
</pre>

'''Exemple de fichier :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.109"
DOMAINE="ecb.nom.domaine"
RP_EXT="O"
CHEMIN="demo"
MDP_PORTAINER="mdp_portainer"
DOSSIER_MDP_KEY="/etc/ssl/certs/ecombox"
DOSSIER_MDP_CHIFFRE="/etc/ssl/certs/ecombox"
</pre>

{{note|type=reminder|Si vous avez téléchargé le fichier param.conf (wget <nowiki>https://forge.apps.education.fr/e-combox/e-comBox_scriptsLinux/raw/4.4/param.conf</nowiki> --output-document param.conf), il suffit de compléter ce dernier au niveau des paramètres voulus.}}

{{note|Tous les paramètres peuvent être renseignés via ce fichier. Dans l'exemple ci-dessus, les paramètres DOSSIER_MDP_KEY et DOSSIER_MDP_CHIFFRE seront également modifiés et mis à jour dans /opt/e-comBox/param.conf.
 
'''Toute option passée en ligne de commandes prend le pas et modifie la valeur correspondante dans le fichier /opt/e-combox/param.conf'''.}}
 L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.109".

Le domaine est "ecb.nom.domaine" et l'interface de l'e-comBox sera accessible via un Reverse Proxy externe. En l'espèce https://ecb.nom.domaine/demo/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 5''' :
<pre>
bash configure_application.sh -f "chemin_vers_fichier"
</pre>

'''Exemple de fichier :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.122"
DOMAINE="ecb.nom.domaine"
RP_EXT="N"
CHEMIN=""
PORT_RP="443"
</pre>

{{note|Tous les paramètres peuvent être renseignés via ce fichier. Dans l'exemple ci-dessus, le paramètre PORT_RP a été modifié et mis à jour dans /opt/e-comBox/param.conf.
 
'''Toute option passée en ligne de commandes prend le pas et modifie la valeur correspondante dans le fichier /opt/e-comBox/param.conf'''.}}

L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.122".

le port du Reverse Proxy interne a été modifié pour utiliser le port par défaut du HTTPS. Ainsi, il n'est plus nécessaire de préciser le port dans l'URL même si l'on ne passe pas par un Revers Proxy externe.
L'interface de l'e-comBox sera accessible via l'URL https://ecb.nom.domaine/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 6 :'''
<pre>
bash configure_application.sh
</pre>

Dans ce cas, le script s'appuie entièrement sur les valeurs des paramètres figurant dans /opt/e-combox/param.conf qu'il faut donc au préalable créer.

{{note|En ce qui concerne le mot de passe de Portainer, il est rappelé qu'il doit obligatoirement être renseigné en cas d'installation ou de réinitialisation de l'instance. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).
 
Par ailleurs, <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}}
 

=== L'accès à l'interface de l'e-comBox ===
L'URL d'accès dépend des informations fournies dans /opt/e-combox/param.conf.

'''Exemple 1 :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.109"
DOMAINE="ecb.nom.domaine"
RP_EXT="O"
CHEMIN="rne"
PORT_RP="8800"
</pre>

L'URL d'accès à l'interface est '''<nowiki>https://ecb.nom.domaine/rne/app/</nowiki>'''
 

{{note/fr}} ecb.nom.domaine peut être remplacé par une adresse IP publique.

'''Exemple 2 :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.111"
DOMAINE=""
RP_EXT="N"
CHEMIN=""
PORT_RP="8800"
</pre>

L'URL d'accès à l'interface est '''<nowiki>https://172.31.40.111:8800/app/</nowiki>'''
 

{{note/fr}} L'adresse IP privée peut être remplacée par un nom de domaine en capacité d'être résolu par un serveur DNS.
 

'''Exemple 3 :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.121"
DOMAINE="ecb.nom.domaine"
RP_EXT="N"
CHEMIN=""
PORT_RP="8800"
</pre>

L'URL d'accès à l'interface est '''<nowiki>https://ecb.nom.domaine:8800/app/</nowiki>'''
 

{{note/fr}} ecb.nom.domaine peut être remplacé par une adresse IP publique.
 

'''Exemple 4 :'''

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

L'URL d'accès à l'interface est '''<nowiki>https://ecb.nom.domaine:8800/app/</nowiki>'''
 

'''Exemple 5 :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.122"
DOMAINE="ecb.nom.domaine"
RP_EXT="N"
CHEMIN=""
PORT_RP="443"
</pre>

L'URL d'accès à l'interface est '''<nowiki>https://ecb.nom.domaine/app/</nowiki>'''
 

=== 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="$BRANCHE.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://forge.apps.education.fr/e-combox_scriptslinux/-/raw/dev/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.
# Cette adresse réseau doit être éventuellement modifiée notamment pour adapter le masque.
# Un site nécessite 2 adresses IP réseau.
# Compte tenu des conteneurs utilitaires, avec un masque en /24, le nombre de sites est limité à 120.
# Cette adresse peut être modifiée ultérieurement.
NET_ECB="192.168.97.0/24"

# Suppression des images non associées à un site en cours d'exécution (false 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 à "true" si vous voulez supprimer ces images (conseillé lors d'une migration).
DEL_IMAGES="false"

# Redémarrage des sites (true par défaut).
# Lors de la mise à jour de l'application il est nécessaire de stopper les sites.
# Mettre cette variable à true relance automatiquement tous les sites qui était lancés avant la mise à jour.
# Définir le paramètre à false si vous ne voulez pas relancer automatiquement les sites.
RESTART_SITES="true"

# Permet de s'authentifier sur le Docker Hub avant de télécharger les images.
# Permet de bénéficier de plus de possibilité de téléchargement d'images toutes les 6 heures.
# Facultatif car il est peu probable que l'utilisation de l'e-comBox soit impactée par les limitations imposées par Docker.
# Voir ici les limitations : https://docs.docker.com/docker-hub/usage/pulls/.
# La troisième variable permet de gérer la désauthentification une fois les téléchargements effectués (true par défaut).
# 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.
LOGIN_DH=""
PASSWORD_DH=""
LOGOUT_DH="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.
NOM_PAYS="France"

# Nom région.
NOM_REGION="Corse"

# Nom organisation.
NOM_ORGANISATION="ReseauCerta"

# Ajout du mode d'authentification pour les comptes non-admin basés sur le protocole OAuth (false par défaut).
# Si false, il n'est pas tenu compte des paramètres qui suivent.
# Si true, vous devez fournir la valeur des paramètres qui suivent.
# Veuillez-vous référer à votre fournisseur OAuth pour déterminer les bonnes valeurs.
OAUTH_ENABLE="false"

# true ou false
# Lors de l'utilisation de SSO (variable à "true"), le fournisseur OAuth n'est pas obligé de demander des informations d'identification.
SSO_ENABLE=""

# Identifiant public de l'application OAuth.
CLIENT_ID=""

# Client Secret
CLIENT_SECRET=""

# URL utilisée pour s'authentifier auprès du fournisseur OAuth.
# L'utilisateur sera redirigé vers la page d'authentification du fournisseur d'identité.
AUTHORIZATION_URL=""

# URL utilisée par Portainer pour échanger un code d'authentification OAuth valide contre un token d'accès.
ACCESS_TOKEN_URL=""

# URL utilisée par Portainer pour récupérer des informations sur l'utilisateur authentifié.
RESOURCE_URL=""

# URL utilisée par Portainer pour rediriger l'utilisateur vers le fournisseur OAuth afin de déconnecter l'utilisateur de la session du fournisseur d'identité.
LOGOUT_URL=""

# Identifiant qui sera utilisé par Portainer pour créer un compte pour l'utilisateur authentifié.
# Extrait du serveur de ressources spécifié via le champ URL de la ressource.
USER_IDENTIFIER=""

# Étendues requises par le fournisseur OAuth pour récupérer des informations sur l'utilisateur authentifié.
SCOPES=""

# Fichier certificat du fournisseur 0Auth avec le chemin complet /chemin/fichier.pem.
# Ce dernier doit potentiellement être intégré à Portainer
CERT_OAUTH=""

# Les variables qui suivent servent à alimenter automatiquement les mentions légales
# si ces dernières n'existent pas ou si le script "modif_mentions_legales.sh" est exécuté.
# Les mentions légales peuvent également être modifiées via l'interface de l'e-comBox.
PROPRIETAIRE=""
ADRESSE_POSTALE=""
IMMATRICULATION=""
HEBERGEUR=""
RESPONSABLE_TRAITEMENT=""
ADMIN_SERVICE=""
DPO=""

# Les variables qui suivent permettent l'envoi d'un courriel à la modification du compte admin des sites.
# Le mode d'envoi est obligatoirement sécurisé.
# Ne fonctionne pas avec gmail qui nécessite l'installation d'un autre outil et d’une configuration différente.
#### Variables obligatoires ####
# URL du serveur SMTP
HOTE_SMTP=""
# Adresse mail qu'il y aura dans le champ From
MAIL_EXPEDITEUR=""
# Port sécurisé (465 ou 587)
PORT_SECURISE_SMTP=""
#### Variables (plus ou moins) facultatives ####
# Attention, les identifiants deviennent de plus en plus obligatoires auprès des FAI
# Faute de quoi, les mails peuvent être rejetés
# Nom de l'utilisateur
USER_SMTP=""
# Mot de passe de l'utilisateur
# Si le mot de passe contient les caractères spéciaux $ ou " ou ` il faut les échapper avec le caractère \.
# SI le mot de passe contient le caractère spécial \ il faut l'échapper avec deux caractères \ (\\).
# Une fois le site créé et le mail envoyé, le mot de passe est supprimé de la configuration du serveur SMTP dans le conteneur.
PASSWORD_SMTP=""
</pre>{{Note/fr|type=info|Il est désormais possible d'ajouter les mentions légales et la politique de confidentialité directement à partir du fichier param.conf grâce aux paramètres ajoutés en fin du fichier param.conf (voir ci-dessus).}}

== Lancement de l'e-comBox et utilisation de base ==

'''En cas de Reverse Proxy externe :'''
* 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 :'''
* 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é.}}

{{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}}

Il faut donc lancer l'application en saisissant :
*l'URL '''https://<nom_domaine>/<chemin>/app/''' en cas de passage par un Reverse proxy externe ;
*l'URL '''https://<adresse_IP ou nom_domaine>:PORT_RP/app/''' en cas de non passage par un Reverse Proxy externe.

{{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]].'''}}

La connexion à l'interface de l'application nécessite obligatoirement une authentification.
[[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]]
Un clic, dans le menu de gauche (par exemple sur Odoo) conduit à un écran similaire à ci-dessous :
[[Fichier:Sites Odoo.png|centré|900x900px]]
 
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.}}

'''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 :
<pre>bash /opt/e-comBox/configure_application.sh [options] </pre> | error}}

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

Installation sur Linux - v4

2025-04-26T01:42:37Z

Aporaf : /* Installation de l'e-comBox 4.4 */

{{note|La '''version 4.4''' est la dernière version. Voir le [[https://forge.apps.education.fr/e-combox/e-combox_documentation/-/blob/4.4/CHANGELOG.md?ref_type=heads|changelog]]|reminder}}

== Préalables ==

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/-/blob/4.4/README.md?ref_type=heads https://forge.apps.education.fr/e-combox/e-comBox_scriptsLinux].

{{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
* Debian 12 (actuellement stable).|reminder}}

Vous pouvez installer une ou plusieurs instances de l'e-comBox derrière un Reverse Proxy externe. Pour configurer ce dernier, consultez la documentation sur la [[https://forge.apps.education.fr/e-combox/e-combox_documentation/-/blob/4.4/installation.md?ref_type=heads#exemples-de-configuration-dun-reverse-proxy|Forge]].

{{Note|L'exécution des scripts doit se faire avec un compte '''administrateur''' (éventuellement en utilisant la commande '''sudo su'''.|error}}

{| class="wikitable"
|-
! '''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
|}

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

{{Note/fr|type=warn|À partir de la version des scripts 4.1.1 (20/04/2023), tous les "B" majuscule dans les noms de dossier basculent en "b" minuscule :
- le dossier d'installation /opt/e-comBox devient /opt/e-combox
- le dossier /opt/ecomBox/e-comBox_portainer devient /opt/ecombox/e-combox_portainer
- le dossier /opt/ecomBox/e-comBox_reverseproxy devient /opt/ecombox/e-combox_reverseproxy
...}}

== Mise à jour de l'e-comBox==

Si vous disposez déjà au minimum d'une version 4.1, la mise à jour est très simple :

1. Télécharger la dernière version du script :
<pre>wget https://forge.apps.education.fr/e-combox/e-combox_scriptslinux/raw/4.4/configure_application.sh --output-document configure_application.sh</pre>

2. Lancer la commande :
<pre>bash configure_application.sh</pre>

{{Note/fr|type=reminder|Le script récupère tous les autres paramètres dans votre ancien fichier /opt/e-comBox/param.conf. D'autres paramètres (non obligatoires) ont été ajoutés pour pouvoir bénéficier de certaines autres fonctionnalités.}}

== Installation de la version 4.4 ==

=== Principe de fonctionnement ===
L'installation se réalise avec le script configure_application.sh. '''Il s'agit d'une installation automatique''' qui installe tous les composants nécessaires. Le script installe l'e-comBox à partir du fichier /opt/e-combox/param.conf (qui a été enrichi de nouveaux paramètres - voir [[Installation sur Linux - v4#Le nouveau fichier param.conf (dans sa version 4.4)|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,
** les différents paramètres (comme le mot de passe de Portainer avec -p mot_de_passe) ;
* sans option sur la ligne de commande si les valeurs des paramètres du fichier /opt/e-combox/param.conf conviennent.

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

{{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 nécessaire de les installer sur les instances (vous pouvez donc laisser le certificat se créer automatiquement comme proposé dans le script). 

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

{{note|À partir de la '''version 4.2''' il est possible de '''configurer une authentification OpenID Connect'''. Pour cela, la variable de param.conf OAUTH_ENABLE doit être mis à "true" et les paramètres suivants renseignés (voir [[Usage des scripts - v4#Configuration de l'authentification openID Connect : configure oauth.sh (version 4.2)|ici]])}}
{{note|À partir de la '''version 4.4''' il est possible de :
* créer des sites via le script "manage_sites.sh" ;
* de remplacer les identifiants par défaut des administrateurs des Prestashop, WordPress et Odoo par le couple mail de l'élève/mot de passe généré aléatoirement.
Pour cela, les variables concernant la configuration d'un serveur SMTP doivent être renseignées dans le fichier param.conf de manière à ce que les identifiants soient envoyés par mail.}}

=== Installation de l'e-comBox 4.4 ===
{{note|[https://forge.apps.education.fr/e-combox/e-combox_documentation/-/blob/4.4/installation.md?ref_type=heads#exemples-de-configuration-dun-reverse-proxy Une documentation sur la configuration d'un reverse-proxy externe], utile en cas de plusieurs instances derrière un même nom de domaine, figure sur la Forge.|reminder}}

'''1. Téléchargement du script configure_application.sh'''

Le téléchargement du script peut se faire à partir de la commande :
<pre>wget https://forge.apps.education.fr/e-combox/e-comBox_scriptsLinux/raw/4.4/configure_application.sh --output-document configure_application.sh</pre>

'''Pour vous simplifier la tache''' vous allez peut-être avoir besoin de télécharger également le fichier param.conf (voir exemple 4) qu'il suffira de compléter avec les principaux paramètres :<pre>wget https://forge.apps.education.fr/e-combox/e-comBox_scriptsLinux/raw/4.4/param.conf --output-document param.conf</pre>

'''2. Exécution du script configure_application.sh'''

{{note|L'exécution du script doit se faire en '''administrateur''' qui est "root" sur Linux (ou en utilisant la commande "sudo su" pour avoir une console "root").}}
<pre>
Usage: bash configure_application.sh [-f "valeur"] [-i "valeur"] [-d "valeur"] [-r "valeur"] [-c "valeur"] [-p "valeur"] [s | b] [-h]
-f Chemin vers le fichier de paramètre [-f "/chemin/nom_fichier"]
-i Adresse IP privée ou nom de domaine correspondant à une adresse IP privée
[-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>

Il existe plusieurs possibilités d'exécution du script, ci-dessous quelques exemples.

'''Exemple 1''' :
<pre>
bash configure_application.sh -i "172.31.40.109" -d "ecb.nom.domaine" -c "rne" -r "O" -p "mdp_portainer"
</pre>

L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.109".

Le domaine est "ecb.nom.domaine" et l'interface de l'e-comBox sera accessible via un Reverse Proxy externe. En l'espèce https://ecb.nom.domaine/rne/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 2''' :
<pre>
bash configure_application.sh -i "172.31.40.111" -p "mdp_portainer"
</pre>

L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.111".

L'interface de l'e-comBox sera accessible uniquement à partir de l'adresse IP privée sur le port 8800 défini par défaut dans le fichier param.conf. En l'espèce https://172.31.40.111:8800/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 3''' :
<pre>
bash configure_application.sh -i "172.31.40.121" -d "ecb.nom.domaine" -p "mdp_portainer"
</pre>

L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.121".

L'interface de l'e-comBox sera accessible à distance sur le port 8800 défini par défaut dans le fichier param.conf mais sans passage par un reverse-proxy externe. En l'espèce https://ecb.nom.domaine:8800/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 4''' :
<pre>
bash configure_application.sh -f "chemin_vers_fichier"
</pre>

'''Exemple de fichier :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.109"
DOMAINE="ecb.nom.domaine"
RP_EXT="O"
CHEMIN="demo"
MDP_PORTAINER="mdp_portainer"
DOSSIER_MDP_KEY="/etc/ssl/certs/ecombox"
DOSSIER_MDP_CHIFFRE="/etc/ssl/certs/ecombox"
</pre>

{{note|type=reminder|Si vous avez téléchargé le fichier param.conf (wget <nowiki>https://forge.apps.education.fr/e-combox/e-comBox_scriptsLinux/raw/4.4/param.conf</nowiki> --output-document param.conf), il suffit de compléter ce dernier au niveau des paramètres voulus.}}

{{note|Tous les paramètres peuvent être renseignés via ce fichier. Dans l'exemple ci-dessus, les paramètres DOSSIER_MDP_KEY et DOSSIER_MDP_CHIFFRE seront également modifiés et mis à jour dans /opt/e-comBox/param.conf.
 
'''Toute option passée en ligne de commandes prend le pas et modifie la valeur correspondante dans le fichier /opt/e-combox/param.conf'''.}}
 L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.109".

Le domaine est "ecb.nom.domaine" et l'interface de l'e-comBox sera accessible via un Reverse Proxy externe. En l'espèce https://ecb.nom.domaine/demo/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 5''' :
<pre>
bash configure_application.sh -f "chemin_vers_fichier"
</pre>

'''Exemple de fichier :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.122"
DOMAINE="ecb.nom.domaine"
RP_EXT="N"
CHEMIN=""
PORT_RP="443"
</pre>

{{note|Tous les paramètres peuvent être renseignés via ce fichier. Dans l'exemple ci-dessus, le paramètre PORT_RP a été modifié et mis à jour dans /opt/e-comBox/param.conf.
 
'''Toute option passée en ligne de commandes prend le pas et modifie la valeur correspondante dans le fichier /opt/e-comBox/param.conf'''.}}

L'adresse IP privée du serveur sur lequel l'instance de l'e-comBox est installée est "172.31.40.122".

le port du Reverse Proxy interne a été modifié pour utiliser le port par défaut du HTTPS. Ainsi, il n'est plus nécessaire de préciser le port dans l'URL même si l'on ne passe pas par un Revers Proxy externe.
L'interface de l'e-comBox sera accessible via l'URL https://ecb.nom.domaine/app.

Le mot de passe de Portainer est "mdp_portainer". '''Ce mot de passe doit obligatoirement être précisé en cas d'installation ou de réinitialisation de l'instance'''. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).

'''Exemple 6 :'''
<pre>
bash configure_application.sh
</pre>

Dans ce cas, le script s'appuie entièrement sur les valeurs des paramètres figurant dans /opt/e-combox/param.conf qu'il faut donc au préalable créer.

{{note|En ce qui concerne le mot de passe de Portainer, il est rappelé qu'il doit obligatoirement être renseigné en cas d'installation ou de réinitialisation de l'instance. Sinon il n'est pas utile de le préciser (sauf si vous l'avez modifié sur Portainer).
 
Par ailleurs, <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}}
 

=== L'accès à l'interface de l'e-comBox ===
L'URL d'accès dépend des informations fournies dans /opt/e-combox/param.conf.

'''Exemple 1 :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.109"
DOMAINE="ecb.nom.domaine"
RP_EXT="O"
CHEMIN="rne"
PORT_RP="8800"
</pre>

L'URL d'accès à l'interface est '''<nowiki>https://ecb.nom.domaine/rne/app/</nowiki>'''
 

{{note/fr}} ecb.nom.domaine peut être remplacé par une adresse IP publique.

'''Exemple 2 :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.111"
DOMAINE=""
RP_EXT="N"
CHEMIN=""
PORT_RP="8800"
</pre>

L'URL d'accès à l'interface est '''<nowiki>https://172.31.40.111:8800/app/</nowiki>'''
 

{{note/fr}} L'adresse IP privée peut être remplacée par un nom de domaine en capacité d'être résolu par un serveur DNS.
 

'''Exemple 3 :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.121"
DOMAINE="ecb.nom.domaine"
RP_EXT="N"
CHEMIN=""
PORT_RP="8800"
</pre>

L'URL d'accès à l'interface est '''<nowiki>https://ecb.nom.domaine:8800/app/</nowiki>'''
 

{{note/fr}} ecb.nom.domaine peut être remplacé par une adresse IP publique.
 

'''Exemple 4 :'''

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

L'URL d'accès à l'interface est '''<nowiki>https://ecb.nom.domaine:8800/app/</nowiki>'''
 

'''Exemple 5 :'''
<pre>
ADRESSE_IP_PRIVEE="172.31.40.122"
DOMAINE="ecb.nom.domaine"
RP_EXT="N"
CHEMIN=""
PORT_RP="443"
</pre>

L'URL d'accès à l'interface est '''<nowiki>https://ecb.nom.domaine/app/</nowiki>'''
 

=== Le nouveau fichier param.conf (dans sa version 4.4) ===
<pre>
#!/bin/bash

# Définition des paramètres utiles à l'application.

# Version du fichier paramètre (ne pas changer la valeur).
VERSION_PARAM="$BRANCHE.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://forge.apps.education.fr/e-combox_scriptslinux/-/raw/dev/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.
# Cette adresse réseau doit être éventuellement modifiée notamment pour adapter le masque.
# Un site nécessite 2 adresses IP réseau.
# Compte tenu des conteneurs utilitaires, avec un masque en /24, le nombre de sites est limité à 120.
# Cette adresse peut être modifiée ultérieurement.
NET_ECB="192.168.97.0/24"

# Suppression des images non associées à un site en cours d'exécution (false 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 à "true" si vous voulez supprimer ces images (conseillé lors d'une migration).
DEL_IMAGES="false"

# Redémarrage des sites (true par défaut).
# Lors de la mise à jour de l'application il est nécessaire de stopper les sites.
# Mettre cette variable à true relance automatiquement tous les sites qui était lancés avant la mise à jour.
# Définir le paramètre à false si vous ne voulez pas relancer automatiquement les sites.
RESTART_SITES="true"

# Permet de s'authentifier sur le Docker Hub avant de télécharger les images.
# Permet de bénéficier de plus de possibilité de téléchargement d'images toutes les 6 heures.
# Facultatif car il est peu probable que l'utilisation de l'e-comBox soit impactée par les limitations imposées par Docker.
# Voir ici les limitations : https://docs.docker.com/docker-hub/usage/pulls/.
# La troisième variable permet de gérer la désauthentification une fois les téléchargements effectués (true par défaut).
# 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.
LOGIN_DH=""
PASSWORD_DH=""
LOGOUT_DH="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.
NOM_PAYS="France"

# Nom région.
NOM_REGION="Corse"

# Nom organisation.
NOM_ORGANISATION="ReseauCerta"

# Ajout du mode d'authentification pour les comptes non-admin basés sur le protocole OAuth (false par défaut).
# Si false, il n'est pas tenu compte des paramètres qui suivent.
# Si true, vous devez fournir la valeur des paramètres qui suivent.
# Veuillez-vous référer à votre fournisseur OAuth pour déterminer les bonnes valeurs.
OAUTH_ENABLE="false"

# true ou false
# Lors de l'utilisation de SSO (variable à "true"), le fournisseur OAuth n'est pas obligé de demander des informations d'identification.
SSO_ENABLE=""

# Identifiant public de l'application OAuth.
CLIENT_ID=""

# Client Secret
CLIENT_SECRET=""

# URL utilisée pour s'authentifier auprès du fournisseur OAuth.
# L'utilisateur sera redirigé vers la page d'authentification du fournisseur d'identité.
AUTHORIZATION_URL=""

# URL utilisée par Portainer pour échanger un code d'authentification OAuth valide contre un token d'accès.
ACCESS_TOKEN_URL=""

# URL utilisée par Portainer pour récupérer des informations sur l'utilisateur authentifié.
RESOURCE_URL=""

# URL utilisée par Portainer pour rediriger l'utilisateur vers le fournisseur OAuth afin de déconnecter l'utilisateur de la session du fournisseur d'identité.
LOGOUT_URL=""

# Identifiant qui sera utilisé par Portainer pour créer un compte pour l'utilisateur authentifié.
# Extrait du serveur de ressources spécifié via le champ URL de la ressource.
USER_IDENTIFIER=""

# Étendues requises par le fournisseur OAuth pour récupérer des informations sur l'utilisateur authentifié.
SCOPES=""

# Fichier certificat du fournisseur 0Auth avec le chemin complet /chemin/fichier.pem.
# Ce dernier doit potentiellement être intégré à Portainer
CERT_OAUTH=""

# Les variables qui suivent servent à alimenter automatiquement les mentions légales
# si ces dernières n'existent pas ou si le script "modif_mentions_legales.sh" est exécuté.
# Les mentions légales peuvent également être modifiées via l'interface de l'e-comBox.
PROPRIETAIRE=""
ADRESSE_POSTALE=""
IMMATRICULATION=""
HEBERGEUR=""
RESPONSABLE_TRAITEMENT=""
ADMIN_SERVICE=""
DPO=""

# Les variables qui suivent permettent l'envoi d'un courriel à la modification du compte admin des sites.
# Le mode d'envoi est obligatoirement sécurisé.
# Ne fonctionne pas avec gmail qui nécessite l'installation d'un autre outil et d’une configuration différente.
#### Variables obligatoires ####
# URL du serveur SMTP
HOTE_SMTP=""
# Adresse mail qu'il y aura dans le champ From
MAIL_EXPEDITEUR=""
# Port sécurisé (465 ou 587)
PORT_SECURISE_SMTP=""
#### Variables (plus ou moins) facultatives ####
# Attention, les identifiants deviennent de plus en plus obligatoires auprès des FAI
# Faute de quoi, les mails peuvent être rejetés
# Nom de l'utilisateur
USER_SMTP=""
# Mot de passe de l'utilisateur
# Si le mot de passe contient les caractères spéciaux $ ou " ou ` il faut les échapper avec le caractère \.
# SI le mot de passe contient le caractère spécial \ il faut l'échapper avec deux caractères \ (\\).
# Une fois le site créé et le mail envoyé, le mot de passe est supprimé de la configuration du serveur SMTP dans le conteneur.
PASSWORD_SMTP=""
</pre>{{Note/fr|type=info|Il est désormais possible d'ajouter les mentions légales et la politique de confidentialité directement à partir du fichier param.conf grâce aux paramètres ajoutés en fin du fichier param.conf (voir ci-dessus).}}

== Lancement de l'e-comBox et utilisation de base ==

'''En cas de Reverse Proxy externe :'''
* 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 :'''
* 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é.}}

{{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}}

Il faut donc lancer l'application en saisissant :
*l'URL '''https://<nom_domaine>/<chemin>/app/''' en cas de passage par un Reverse proxy externe ;
*l'URL '''https://<adresse_IP ou nom_domaine>:PORT_RP/app/''' en cas de non passage par un Reverse Proxy externe.

{{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]].'''}}

La connexion à l'interface de l'application nécessite obligatoirement une authentification.
[[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]]
Un clic, dans le menu de gauche (par exemple sur Odoo) conduit à un écran similaire à ci-dessous :
[[Fichier:Sites Odoo.png|centré|900x900px]]
 
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.}}

'''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 :
<pre>bash /opt/e-comBox/configure_application.sh [options] </pre> | error}}

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