« Premiers pas - v4 » et « Usage des scripts - 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:Menu Gauche détaillé v4.png|droite|641x641px]]
{{note | De nombreux scripts pour gérer l'application sont fournis dans la '''version 4.1'''. Une brève description pour chacun d'entre eux est donné ci-dessous. | reminder}}
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 nécessite de se connecter via un compte "Prof". Voir [[Gestion_Utilisateurs|ici]] le mode opératoire.}}
== Gestion des certificats : manage_certificats.sh ==


== L'interface de l'e-comBox ==
{{note | Ce script permet la création et la mise à jour du certificat pour l'accès à l'interface de l'e-comBox. Des options doivent être passées en ligne de commande (voir Usage ci-après).}}                                                                                   
L'interface de l'e-comBox est composée d'un menu à gauche, d'un bandeau avec :
<pre>
Usage: bash /opt/e-comBox/manage_certificats.sh -c|u [-m "valeur"] [-a] [-h]
  -c Création et mise en place d'un certificat Lets'encrypt
  -u Mise à jour du certificat à partir des paramètres du fichier param.conf
  -m Adresse de courriel  [-m "adresse courriel"], non obligatoire
  -a Installation de la mise à jour automatique du certificat lorsque celui-ci est expiré. Cette option n'a d'utilité qu'une seule fois
  -h Détail des options
</pre>
'''L'option "-c"''' automatise la création et l'installation d'un certificat Let's Encrypt directement utilisable pour l'application.


* un raccourci vers la page d'aide,  
{{note|Votre instance doit être joignable sur le port 80.  Attention, vous n'avez pas à installer de serveur Web, le script se charge de tout. L'instance doit juste être en mesure de répondre à une requête de type http://votre_nom_de_domaine (où le nom de domaine est la valeur renseigné dans la paramètre DOMAINE de param.conf). Une redirection peut donc être nécessaire.|warn}}
* 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é :
'''Le script :'''
[[Fichier:Accueil v4.png|centré|900x900px]]
* crée le certificat en utilisant le paramètre "DOMAINE" du param.conf de de manière optionnelle le paramètre MAIL (qui peut être soit renseigné dans param.conf soit directement ajouté via l'option "-m" de la ligne de commande) ;
Le tableau de bord permet d'avoir une vue d'ensemble sur :
* copie les fichiers dans /opt/e-comBox/letsencrypt/live/<domaine> ;
* la version de l'e-comBox ;
* renseigne les paramètres correspondants de param.conf :
* le nombre de sites créés ainsi que leur état (démarré ou stoppé) ;
** CHEMIN_CERT="/opt/e-comBox/letsencrypt/live/<domaine>/fullchain.pem"
* l'instance de l'e-comBox ;
** CHEMIN_KEY="/opt/e-comBox/letsencrypt/live/<domaine>/privkey.pem"
* le nom de l'utilisateur connecté ;
** MAIL (si un mail est passé en ligne de commande) ;
* les ressources utilisées (mémoire, espace de stockage et CPU) en cliquant sur le lien correspondant.
* installe le certificat au niveau de l'application.
[[Fichier:Dashboard v4.png|centré|900x900px]]


== Gestion des sites ==
'''L'option "-a"''' (que l'on peut activer ultérieurement) met en place une tâche automatique qui vérifie quotidiennement si le certificat a expiré et le met à jour le cas échéant.
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 ===
'''L'option "-u"''' :


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) :
* met à jour le certificat de l'e-comBox si des valeurs à CHEMIN_CERT et à CHEMIN_KEY sont modifiées, ajoutées ou supprimées ;
* met à jour le certificat de l'e-comBox (si ce type de certificat auto-signé est utilisé) mais aussi d'autres certificats nécessaires qui s'appuient sur les variables CODE_PAYS, NOM_PAYS, NOM_REGION, NOM_ORGANISATION. Ainsi, si au moins une de ces 4 paramètres sont modifiés, il est nécessaire de mettre à jour les certificats.


== Réinitialisation de l'application : reinitialise_application.sh ==
{{note|Ce script permet de réinitialiser l'application.  Des options doivent être passées en ligne de commande (voir Usage ci-après).|}}{{Note/fr|type=error|Attention, tous les sites seront perdus.}}<pre>
Usage: bash /opt/e-comBox/reinitialise_application.sh -f [-n] [-v "valeur"] [-i "valeur"] [-d "valeur"] [-r "valeur"] [-c "valeur"] [-p "valeur"] [-h]
  -f Suppression de tous les conteneurs, volumes, réseaux et images.
  -n Réinstallation de l'application.
  -v Version de l'application à installer si vous voulez changer de version [-v "version"].
  -i Adresse IP privée nom de domaine correspondant à une adresse IP privée  [-i "@IP_PRIVEE" | -i "nom_domaine"].
  -d Adresse IP publique nom de domaine correspondant à une adresse IP publique  [-d "@IP_PUBLIQUE" | -d "nom_domaine"].
        Pour supprimer une valeur existante -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
  -h Détail des options.
</pre>


[[File:DocUtilisateur-images-image22.png|1000px|centre]]
'''L'option "-f"''' est obligatoire, elle force la suppression des conteneurs, volumes, réseaux et images.


[[File:DocUtilisateur-images-image16.png|400px|droite]]
L'ajout de '''l'option "-n"''' permet de réinstaller l'application en changeant éventuellement la version via l'option "-v".
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'''''.


{{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.}}
Sans l'option "-n", l'application n'est pas réinstallée mais est prête à l'être, l'ancien fichier param.conf sera sauvegardé en param.sauv.conf et un fichier param.conf contenant les valeurs pas défaut sera téléchargé.
<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]]
<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.}}


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'' :
Dans le cadre d'une réinstallation, '''l'option "-p"''' est obligatoire si un mot de passe pour Portainer n'a pas été renseigné dans le param.conf car, lors de la réinitialisation, les anciens identifiants de Portainer ont également été réinitialisés.
<br>
{{note | Le mot de passe ne peut pas contenir les caractères " et $.| warn}}
Les '''autres options''' servent à la réinstallation de l'application pour alimenter le fichier param.conf, options identiques à celles utilisables lors de la configuration de l'application via le script configure_application.sh.


[[File:Images13.png|900x900px|centre]]
== Suppression de l'application : delete_application.sh ==
{{note | Ce script permet de supprimer l'application e-comBox. Une option -e ou -a doit obligatoirement être passée en ligne de commande (voir Usage ci-après).}}
<pre>
Usage: bash /opt/e-comBox/delete_application.sh -e | -a [-h]
  -e Suppression de l'application uniquement
  -a Suppression de l'application, docker et docker-compose
  -h Détail des options
</pre>


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) :
'''L'option "-e"''' supprime uniquement l'application.
[[Fichier:Creation 4 blogs.png|centré|900x900px]]
{{note | Attention, le dossier /opt/e-comBox sera supprimé ainsi que les logs.|warn}}
Quatre sites de noms "blog-eleve1" à "blog-eleve4" seront créés :
[[Fichier:Creation plusieurs sites.png|centré|900x900px]]




'''Pour les sites Prestashop et WooCommerce''', il est possible de créer 2 types de sites :
'''L'option "-a"''' supprime également Docker et Docker Compose.
* '''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'' :  
== Mise à jour de l'application : update_ecb.sh ==
[[Fichier:Creation presta.png|centré|900x900px]]
{{Note/fr|Lorsqu'une nouvelle image de l'e-comBox est disponible, ce script met à jour l'application sans que l'on soit obligé de dérouler le script configure_application.sh.}}
'''De même pour les sites Odoo''', il est possible de choisir entre les versions 12,13, 14 ou des images personnalisées :
Il est exécutable sans option.
[[Fichier:Creation odoo.png|centré|900x900px]]
=== Démarrer/arrêter un site ===


Un site démarré est affiché de la façon suivante :
== Mise à jour des images : manage_images.sh ==
[[Fichier:Site demarre.png|centré|600x600px]]
{{note|Ce script permet de supprimer et de gérer les images de l'e-comBox sans être obligé de reconfigurer l'application.. Des options doivent être renseignées en ligne de commande (voir Usage ci-après).}}
Un clic sur le bouton bleu (interrupteur) permet alors d'arrêter le site. Un site stoppé est affiché de la façon suivante :
[[File:Image2.png|600px|centre]]
Un nouveau clic sur l'interrupteur permet de le démarrer.<br>


{{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>
Usage: bash /opt/e-comBox/manage_images.sh -d|u [-a] [-p] [-w] [-b] [-m] [-s] [-o] [-k] [-b] [-i "nom_image"] [-f "nom_image" | -f "type_image"] [h]
  -d Suppression des images non associées à un site en cours d'exécution [-d]
  -u Mise à jour des images. Les sites doivent être redémarrés pour la mise à jour soit effective [-u]
  -a L'action porte sur toutes les images existantes.
  -p Suppression ou mise à jour des images Prestashop [-p]
  -w Suppression ou mise à jour des images WooCommerce [-w]
  -b Suppression ou mise à jour des images Blog [-b]
  -m Suppression ou mise à jour des images Mautic [-m]
  -s Suppression ou mise à jour des images Suite CRM [-s]
  -o Suppression ou mise à jour des images Odoo [-o]
  -k Suppression ou mise à jour des images Kanboard [-k]
  -b Suppression ou mise à jour des images HumHub [-b]
  -i Suppression ou mise à jour d'une image spécifique [-i "nom_image"]
  -f Mise à jour d'une image utilitaire [-f "nom_image" | -f "type_image"]
  -h Détail des options
</pre>'''L'opération de suppression d'images''' peut être utile pour gagner de la place. Certaines images prennent de la place sur le disque dur sans être utilisées. C'est une opération qui peut être salutaire et qui est sans risque, il n'est pas possible de supprimer des images associées à des sites en cours d'exécution. Le seul inconvénient est que le démarrage des sites seraun peu plus lent car il faudra télécharger de nouveau les images correspondantes.


=== Accéder à un site ===
'''La mise a jour de l'image''' peut s'avérer nécessaire si celle-ci a été mise à jour suite à un bug ou à une faille de sécurité.


Pour accéder à un site, ce dernier doit être démarré.
== Configuration ou re-configuration de l'intégralité de l'application : configure_application.sh ==
{{note|Ce script doit être utilisé pour :
* installer l'application ;
* re-configurer l'application si des éléments importants de l'environnement ont changé (adresse IP, domaine, passage par un Reverse Proxy externe, passage par un proxy).
Il peut être utilisé avec des options facultatives qui remplacent les valeurs du fichier param.conf.
La valeur des principaux paramètres peut être passée directement en ligne de commande (voir Usage ci-après).}}
<pre>
Usage: configure_application.sh [-f "valeur"] [-i "valeur"] [-d "valeur"] [-r "valeur"] [-c "valeur"] [-p "valeur"] [-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 passent pas 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>


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é.
Voir également la partie sur [[https://wiki-ecombox.btssio.corsica/index.php/Installation_sur_Linux_-_v4#Installation_de_l'e-comBox_4.1|l'installation de l'application]].


'''Les URL peuvent être visualisées :'''
== Réinitialisation du mot de passe de Portainer : reset_pass_portainer.sh ==
{{Note|Ce script permet de réinitialiser, en cas de perte, le mot de passe de Portainer. L'option "-f" doit obligatoirement être passée en ligne de commande (voir Usage ci-après).}}
<pre>
Usage: /opt/e-comBox/reset_pass_portainer.sh -f [-h]
-f Réinitialisation du mot de passe de Portainer
-h Détail des options
</pre>


* '''Au survol du lien ''Accéder au site'' :'''
{{Note | Vous devez ensuite vous connecter sur Portainer pour modifier le mot de passe fourni afin que ce dernier soit compatible avec l'application. <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}}
[[Fichier:Affiche URL.png|centré|600x600px]]


* '''Au clic sur le bouton ''Afficher les URL'' :'''
== Sauvegarde et Restauration (en cours...) ==
[[Fichier:Btn affiche URL.png|centré|600x600px]]
=== sauv_sites.sh ===
{{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>''.
=== restaure_sites.sh ===
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)'''.}}
=== restaure_v3.sh ===
 
== Utilisation d'Ansible (en cours...) ==
=== 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'' :
[[Fichier:Export pdf.png|centré|400x400px]]
Le bouton ''Exporter'' permet de générer et d'ouvrir automatiquement un fichier PDF contenant cette liste :
[[Fichier:Pdf.png|centré|600x600px]]
{{Note/fr|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 :
[[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>
 
=== 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 : {{color|red|'''à utiliser avec prudence'''}}.
 
=== Accès SFTP ===
 
L'accès SFTP permet d'accéder aux sources des sites Prestashop et Odoo.
[[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é.}}
 
Lorsque le SFTP est activé pour un site l'affichage est du type :
[[Fichier:Sftp active.png|centré|600x600px]]
{{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
 
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é.}}
 
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.}}
 
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''.
[[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 ==
 
=== 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 ===
 
{| 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
|
|}
 
 
==== Configuration de Mautic ====
[[File:Image26.png|600px|droite]]
Mautic doit être configuré avec les éléments suivants :
<br>
<br>
{{note/fr}} Database Password : le mot de passe est donné sur l'interface au moment de la création du site.
<br>
[[Fichier:Mautic.png|gauche|600x600px]]
<br clear=all>
 
Pour Basculer Mautic en français via l'interface graphique :
* roue dentée/configuration/system setting ;
* puis ''Apply'' ou ''Save &amp; Close'' ;
* se reconnecter.
 
{{note/fr}} Il est possible de changer d'autres paramètres comme ''Default timezone''.
 
{{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.
 
====Basculer Kanboard en français====
 
Sur l'interface graphique :
# Aller dans la rubrique Application settings.
# Modifier la langue, le fuseau horaire et le format des dates.
# Enregistrer.
 
== 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 à 01:47

De nombreux scripts pour gérer l'application sont fournis dans la version 4.1. Une brève description pour chacun d'entre eux est donné ci-dessous.

Gestion des certificats : manage_certificats.sh

Ce script permet la création et la mise à jour du certificat pour l'accès à l'interface de l'e-comBox. Des options doivent être passées en ligne de commande (voir Usage ci-après).
Usage: bash /opt/e-comBox/manage_certificats.sh -c|u [-m "valeur"] [-a] [-h]
  -c	Création et mise en place d'un certificat Lets'encrypt
  -u	Mise à jour du certificat à partir des paramètres du fichier param.conf
  -m	Adresse de courriel  [-m "adresse courriel"], non obligatoire
  -a	Installation de la mise à jour automatique du certificat lorsque celui-ci est expiré. Cette option n'a d'utilité qu'une seule fois
  -h	Détail des options

L'option "-c" automatise la création et l'installation d'un certificat Let's Encrypt directement utilisable pour l'application.

Votre instance doit être joignable sur le port 80. Attention, vous n'avez pas à installer de serveur Web, le script se charge de tout. L'instance doit juste être en mesure de répondre à une requête de type http://votre_nom_de_domaine (où le nom de domaine est la valeur renseigné dans la paramètre DOMAINE de param.conf). Une redirection peut donc être nécessaire.

Le script :

  • crée le certificat en utilisant le paramètre "DOMAINE" du param.conf de de manière optionnelle le paramètre MAIL (qui peut être soit renseigné dans param.conf soit directement ajouté via l'option "-m" de la ligne de commande) ;
  • copie les fichiers dans /opt/e-comBox/letsencrypt/live/<domaine> ;
  • renseigne les paramètres correspondants de param.conf :
    • CHEMIN_CERT="/opt/e-comBox/letsencrypt/live/<domaine>/fullchain.pem"
    • CHEMIN_KEY="/opt/e-comBox/letsencrypt/live/<domaine>/privkey.pem"
    • MAIL (si un mail est passé en ligne de commande) ;
  • installe le certificat au niveau de l'application.

L'option "-a" (que l'on peut activer ultérieurement) met en place une tâche automatique qui vérifie quotidiennement si le certificat a expiré et le met à jour le cas échéant.

L'option "-u" :

  • met à jour le certificat de l'e-comBox si des valeurs à CHEMIN_CERT et à CHEMIN_KEY sont modifiées, ajoutées ou supprimées ;
  • met à jour le certificat de l'e-comBox (si ce type de certificat auto-signé est utilisé) mais aussi d'autres certificats nécessaires qui s'appuient sur les variables CODE_PAYS, NOM_PAYS, NOM_REGION, NOM_ORGANISATION. Ainsi, si au moins une de ces 4 paramètres sont modifiés, il est nécessaire de mettre à jour les certificats.

Réinitialisation de l'application : reinitialise_application.sh

Ce script permet de réinitialiser l'application. Des options doivent être passées en ligne de commande (voir Usage ci-après).
Attention, tous les sites seront perdus.
Usage: bash /opt/e-comBox/reinitialise_application.sh -f [-n] [-v "valeur"] [-i "valeur"] [-d "valeur"] [-r "valeur"] [-c "valeur"] [-p "valeur"] [-h]
  -f	Suppression de tous les conteneurs, volumes, réseaux et images.
  -n	Réinstallation de l'application.
  -v	Version de l'application à installer si vous voulez changer de version [-v "version"].
  -i	Adresse IP privée nom de domaine correspondant à une adresse IP privée  [-i "@IP_PRIVEE" | -i "nom_domaine"].
  -d	Adresse IP publique nom de domaine correspondant à une adresse IP publique  [-d "@IP_PUBLIQUE" | -d "nom_domaine"]. 
        Pour supprimer une valeur existante -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
  -h	Détail des options.

L'option "-f" est obligatoire, elle force la suppression des conteneurs, volumes, réseaux et images.

L'ajout de l'option "-n" permet de réinstaller l'application en changeant éventuellement la version via l'option "-v".

Sans l'option "-n", l'application n'est pas réinstallée mais est prête à l'être, l'ancien fichier param.conf sera sauvegardé en param.sauv.conf et un fichier param.conf contenant les valeurs pas défaut sera téléchargé.

Dans le cadre d'une réinstallation, l'option "-p" est obligatoire si un mot de passe pour Portainer n'a pas été renseigné dans le param.conf car, lors de la réinitialisation, les anciens identifiants de Portainer ont également été réinitialisés.

Le mot de passe ne peut pas contenir les caractères " et $.

Les autres options servent à la réinstallation de l'application pour alimenter le fichier param.conf, options identiques à celles utilisables lors de la configuration de l'application via le script configure_application.sh.

Suppression de l'application : delete_application.sh

Ce script permet de supprimer l'application e-comBox. Une option -e ou -a doit obligatoirement être passée en ligne de commande (voir Usage ci-après).
Usage: bash /opt/e-comBox/delete_application.sh -e | -a [-h]
  -e	Suppression de l'application uniquement
  -a	Suppression de l'application, docker et docker-compose
  -h	Détail des options

L'option "-e" supprime uniquement l'application.

Attention, le dossier /opt/e-comBox sera supprimé ainsi que les logs.


L'option "-a" supprime également Docker et Docker Compose.

Mise à jour de l'application : update_ecb.sh

Lorsqu'une nouvelle image de l'e-comBox est disponible, ce script met à jour l'application sans que l'on soit obligé de dérouler le script configure_application.sh.

Il est exécutable sans option.

Mise à jour des images : manage_images.sh

Ce script permet de supprimer et de gérer les images de l'e-comBox sans être obligé de reconfigurer l'application.. Des options doivent être renseignées en ligne de commande (voir Usage ci-après).
Usage: bash /opt/e-comBox/manage_images.sh -d|u [-a] [-p] [-w] [-b] [-m] [-s] [-o] [-k] [-b] [-i "nom_image"] [-f "nom_image" | -f "type_image"] [h]
  -d	Suppression des images non associées à un site en cours d'exécution [-d]
  -u	Mise à jour des images. Les sites doivent être redémarrés pour la mise à jour soit effective [-u]
  -a	L'action porte sur toutes les images existantes.
  -p	Suppression ou mise à jour des images Prestashop [-p]
  -w	Suppression ou mise à jour des images WooCommerce [-w]
  -b	Suppression ou mise à jour des images Blog [-b]
  -m	Suppression ou mise à jour des images Mautic [-m]
  -s	Suppression ou mise à jour des images Suite CRM [-s]
  -o	Suppression ou mise à jour des images Odoo [-o]
  -k	Suppression ou mise à jour des images Kanboard [-k]
  -b	Suppression ou mise à jour des images HumHub [-b]
  -i	Suppression ou mise à jour d'une image spécifique [-i "nom_image"]
  -f	Mise à jour d'une image utilitaire [-f "nom_image" | -f "type_image"]
  -h	Détail des options

L'opération de suppression d'images peut être utile pour gagner de la place. Certaines images prennent de la place sur le disque dur sans être utilisées. C'est une opération qui peut être salutaire et qui est sans risque, il n'est pas possible de supprimer des images associées à des sites en cours d'exécution. Le seul inconvénient est que le démarrage des sites seraun peu plus lent car il faudra télécharger de nouveau les images correspondantes.

La mise a jour de l'image peut s'avérer nécessaire si celle-ci a été mise à jour suite à un bug ou à une faille de sécurité.

Configuration ou re-configuration de l'intégralité de l'application : configure_application.sh

Ce script doit être utilisé pour :
  • installer l'application ;
  • re-configurer l'application si des éléments importants de l'environnement ont changé (adresse IP, domaine, passage par un Reverse Proxy externe, passage par un proxy).

Il peut être utilisé avec des options facultatives qui remplacent les valeurs du fichier param.conf.

La valeur des principaux paramètres peut être passée directement en ligne de commande (voir Usage ci-après).
Usage: configure_application.sh [-f "valeur"] [-i "valeur"] [-d "valeur"] [-r "valeur"] [-c "valeur"] [-p "valeur"] [-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 passent pas 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

Voir également la partie sur [de l'application].

Réinitialisation du mot de passe de Portainer : reset_pass_portainer.sh

Ce script permet de réinitialiser, en cas de perte, le mot de passe de Portainer. L'option "-f" doit obligatoirement être passée en ligne de commande (voir Usage ci-après).
Usage: /opt/e-comBox/reset_pass_portainer.sh -f [-h]
	-f		Réinitialisation du mot de passe de Portainer
	-h		Détail des options
Vous devez ensuite vous connecter sur Portainer pour modifier le mot de passe fourni afin que ce dernier soit compatible avec l'application. 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.

Sauvegarde et Restauration (en cours...)

sauv_sites.sh

restaure_sites.sh

restaure_v3.sh

Utilisation d'Ansible (en cours...)

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