Ce guide explique comment installer un thème ou un composant de thème Discourse à partir d’un dépôt GitHub privé.
Niveau d’utilisateur requis : Administrateur
Résumé
Cette documentation couvre le processus d’installation d’un thème ou d’un composant de thème Discourse à partir d’un dépôt GitHub privé. Elle comprend les étapes pour générer et utiliser des clés SSH pour un accès sécurisé. Vous devez disposer d’un accès administrateur à la fois à votre instance Discourse et au dépôt GitHub que vous installez. Voici comment vous pouvez utiliser vos propres thèmes et composants de thème privés sur votre forum.
Prérequis
Avant de commencer, assurez-vous d’avoir :
- Un accès administrateur à votre instance Discourse
- Un dépôt Git privé contenant votre thème ou composant
- L’accès pour ajouter des clés de déploiement à votre dépôt Git (niveau admin/propriétaire)
Guide étape par étape
- Rendez-vous sur votre dépôt GitHub privé et copiez l’adresse SSH depuis l’onglet Cloner SSH.
2. Naviguez vers votre panneau d’administration Discourse.
3. Dans la barre latérale d’administration, allez à
Apparence > Thèmes et composants, puis sélectionnez l’onglet Thèmes ou Composants (selon ce que vous installez). 4. Cliquez sur
Installer puis sélectionnez Depuis un dépôt git.
5. Collez l’adresse SSH que vous avez copiée du dépôt privé à l’étape 1. Elle doit être au format :
git@github.com:NOMUTILISATEUR/NOM-DEPOT.git.
Assurez-vous d’utiliser le lien cloner avec SSH, et non celui qui commence par
https
6. Une clé SSH est automatiquement générée et affichée dans une nouvelle zone de texte.
7. Cliquez sur l’icône de copie dans le coin supérieur droit de cette boîte pour copier la nouvelle clé SSH. Ne cliquez pas sur installer et ne fermez pas cette modale pour l’instant.
8. Maintenant, allez aux paramètres de votre dépôt GitHub privé (par exemple, sur GitHub, allez à
Paramètres > Clés de déploiement)
9. Ajoutez une nouvelle clé de déploiement. Vous devrez lui donner un titre approprié. Collez la clé SSH que vous avez copiée de Discourse dans le champ de la clé de déploiement.
10. Cliquez sur
Ajouter la clé pour enregistrer la clé de déploiement dans les paramètres de votre dépôt Git.
11. Retournez à la modale d’installation du thème Discourse et cliquez sur le bouton
Installer. Vous devriez maintenant voir la page des paramètres de votre nouveau thème ou composant.
Bonnes pratiques
- Utilisez toujours l’URL SSH pour votre dépôt, et non l’URL HTTPS.
- Gardez vos clés de déploiement en sécurité et ne les partagez pas publiquement.
- Mettez régulièrement à jour votre thème ou vos composants pour vous assurer d’avoir les dernières fonctionnalités et mises à jour de sécurité.
FAQ
Q : Puis-je utiliser cette méthode avec des fournisseurs Git autres que GitHub ?
R : Oui, cette méthode devrait fonctionner avec tout fournisseur Git qui prend en charge les clés de déploiement ou l’authentification SSH.
Q : Discourse mémorisera-t-il la clé SSH pour les futures mises à jour ?
R : Oui, Discourse stockera la clé privée générée et l’utilisera pour les accès futurs au dépôt Git.
Q : Puis-je changer le dépôt privé plus tard ?
R : Oui, vous pouvez mettre à jour l’URL du dépôt dans les paramètres du thème si nécessaire.
Ressources supplémentaires
Les clés SSH utilisées dans ce sujet n’ont été générées que pour cette documentation