Étapes à suivre

Ci-dessous les étapes à suivre par l'équipe technique du client pour l'installation d'un module Atoo Sync Magento.

Génération de la clé SSH

Si vous n'avez pas déjà de clé SSH ou si vous souhaitez en créer une spécifiquement pour ce projet, suivez ces étapes :

# Générez une nouvelle paire de clés SSH
ssh-keygen -t rsa -b 4096 -f nom_de_la_cle

Lorsqu'il vous sera demandé de saisir une phrase secrète, vous pouvez soit en définir une (recommandé) soit appuyer sur Entrée pour ne pas en définir.

Autorisation de la clé

Affichez le contenu de la clé publique :

cat ~/.ssh/nom_de_la_cle.pub

Copiez le contenu et envoyez-le nous pour que autorisions votre clé. Veillez à ne jamais partager la clé privée.

Configuration SSH (après confirmation de l'ajout de la clé par l'administrateur)

Assurez-vous que la clé est bien prise en compte dans vos configurations SSH. Si vous utilisez cette clé pour plusieurs projets, ou pour éviter tout conflit avec d'autres configurations, ajoutez une entrée dans ~/.ssh/config :

Host alias_github
    HostName github.com
    User git
    IdentityFile ~/.ssh/nom_de_la_cle
    IdentitiesOnly yes

L'alias alias_github est utilisé pour spécifier cette configuration spécifique lors de la connexion.

Installation du projet via Composer

Modifiez (ou créez si nécessaire) le fichier composer.json de votre projet pour ajouter le dépôt en utilisant l'alias :

Pour le module atoosync-magento-export-compta :

{
    "repositories": [
        {
            "type": "vcs",
            "url": "git@alias_github:atoonext/atoosync-magento-export-compta.git"
        }
    ]
}

Pour le module atoosync-magento-gescom :

{
    "repositories": [
        {
            "type": "vcs",
            "url": "git@alias_github:atoonext/atoosync-magento-gescom.git"
        }
    ]
}

Exécutez ensuite la commande suivante pour installer le paquet :

Pour le module atoosync-magento-export-compta :

composer require atoonext/atoosync-magento-export-compta

Pour le module atoosync-magento-gescom :

composer require atoonext/atoosync-magento-gescom

Vous pouvez partager cette procédure avec l'équipe technique de votre client. Une fois qu'ils vous ont fourni la clé publique, n'oubliez pas de l'ajouter aux "Deploy keys" du dépôt GitHub concerné.

Activation et déploiement du module dans Magento 2

Pour le module atoosync-magento-export-compta :

Activez le module. Exécutez :

php bin/magento module:enable AtooSync_ExportCompta

Pour le module atoosync-magento-gescom :

Activez le module. Exécutez :

php bin/magento module:enable AtooSync_GesCom

Mettez à jour la base de données pour tenir compte des éventuelles modifications de schéma ou des données liées au module :

php bin/magento setup:upgrade

Compilez le code Magento :

php bin/magento setup:di:compile

Déployez les fichiers statiques. Ceci est particulièrement nécessaire si vous êtes en mode "production" :

php bin/magento setup:static-content:deploy

Nettoyez le cache. Il est toujours recommandé de vider le cache après l'installation d'un nouveau module pour s'assurer que toutes les modifications sont bien prises en compte :

php bin/magento cache:clean