« Usage des scripts - v4 » : différence entre les versions

De Documentation e-comBox
Ligne 60 : Ligne 60 :


== Suppression de l'application : delete_application.sh ==
== Suppression de l'application : delete_application.sh ==
'''Dans quelle situation ?'''
{{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>
Ce script permet de supprimer l'application e-comBox.
Usage: bash /opt/e-comBox/delete_application.sh -e | -a [-h]
Attention, le dossier /opt/e-comBox sera supprimé ainsi que les logs.
Une option -e ou -a doit obligatoirement être passée en ligne de commande (voir Usage ci-après).
Usage: /opt/e-comBox/delete_application.sh -e | -a [-h]
-e Suppression de l'application uniquement
-e Suppression de l'application uniquement
-a Suppression de l'application, docker et docker-compose
-a Suppression de l'application, docker et docker-compose
-h Détail des options
-h Détail des options
</pre>
'''L'option "-e"''' supprime uniquement l'application.
{{note | Attention, le dossier /opt/e-comBox sera supprimé ainsi que les logs.|warn}}
'''L'option "-a"''' supprime également Docker et Docker Compose.


== Mise à jour de l'application : update_ecb.sh ==  
== Mise à jour de l'application : update_ecb.sh ==  

Version du 23 février 2023 à 20:02

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).
Usage: bash /opt/e-comBox/reinitialise_application.sh -f [-n] [-v "valeur"] [-i "valeur"] [-d "valeur"] [-r "valeur"] [-c "valeur"] [-p "valeur"] [-o "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"].
  -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.

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

Dans quelle situation ?

Mise à jour des images : manage_images.sh

Dans quelle situation ?

bash /opt/e-comBox/manage_images.sh -h Ce script permet de supprimer et de gérer les images de l'e-comBox. Des options doivent être renseignées en ligne de commande (voir Usage ci-après).

Usage: /opt/e-comBox/manage_images.sh -d|u [-a] [-p] [-w] [-b] [-m] [-s] [-o] [-k] [-b] [-i "nom_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 suppression ou mise à jour d'une image utilitaire [-f "nom_image" || -f "type_image"] -h Détail des options


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

Dans quelle situation ?

bash /opt/e-comBox/configure_application.sh -h 1 ⨯ Ce script permet d'installer l'application e-comBox et 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). Le mot de passe ne peut pas contenir les caractères " et $. À noter que l'utilisation de l'option "f" permet de passer l'ensemble des paramètres qui doivent être modifiés dans param.conf.

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 un nom de domaine correspondant à une adresse IP privée [-i "@IP_PRIVEE" | -i "nom_domaine"] -d Adresse IP publique ou un 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"] -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


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

Dans quelle situation ? Quand vous avez perdu votre mot de passe de Portainer.

bash /opt/e-comBox/reset_pass_portainer.sh -h

Ce script permet de réinitialiser le mot de passe de Portainer. L'option -f doit obligatoirement être passée en ligne de commande (voir Usage ci-après). À noter que vous devez ensuite vous connecter sur Portainer pour modifier le mot de passe fourni afin que ce dernier soit compatible (il ne doit pas contenir les caractères spéciaux " et `). Usage: /opt/e-comBox/reset_pass_portainer.sh -f [-h] -f Réinitialisation du mot de passe de Portainer -h Détail des options

Sauvegarde et Restauration

sauv_sites.sh

restaure_sites.sh

restaure_v3.sh

Utilisation d'Ansible