Diese Anleitung erklärt, wie ein Discourse-Theme oder eine Theme-Komponente aus einem privaten GitHub-Repository installiert wird.
Erforderliches Benutzerniveau: Administrator
Zusammenfassung
Diese Dokumentation beschreibt den Prozess der Installation eines Discourse-Themes oder einer Theme-Komponente aus einem privaten GitHub-Repository. Sie enthält Schritte zur Generierung und Verwendung von SSH-Schlüsseln für den sicheren Zugriff. Sie benötigen Administratorzugriff sowohl auf Ihre Discourse-Instanz als auch auf das GitHub-Repository, das Sie installieren möchten. So können Sie Ihre eigenen privaten Themes und Theme-Komponenten auf Ihrem Forum nutzen.
Voraussetzungen
Stellen Sie vor Beginn sicher, dass Sie Folgendes haben:
- Administratorzugriff auf Ihre Discourse-Instanz
- Ein privates Git-Repository, das Ihr Theme oder Ihre Komponente enthält
- Zugriff zum Hinzufügen von Deploy-Keys zu Ihrem Git-Repository (Admin-/Owner-Level)
Schritt-für-Schritt-Anleitung
- Gehen Sie zu Ihrem privaten GitHub-Repository und kopieren Sie die SSH-Adresse aus der Registerkarte „SSH klonen“.
2. Navigieren Sie zu Ihrem Discourse-Admin-Panel.
3. Gehen Sie in der Admin-Seitenleiste zu
Erscheinungsbild > Themes und Komponenten und wählen Sie dann die Registerkarte Themes oder Komponenten (je nachdem, was Sie installieren). 4. Klicken Sie auf
Installieren und wählen Sie dann Aus einem Git-Repository.
5. Fügen Sie die SSH-Adresse ein, die Sie in Schritt 1 aus dem privaten Repository kopiert haben. Sie sollte das Format haben:
git@github.com:BENUTZERNAME/REPO-NAME.git.
Stellen Sie sicher, dass Sie den Link zum Klonen mit SSH verwenden, nicht den, der mit
httpsbeginnt.
6. Ein SSH-Schlüssel wird automatisch generiert und in einem neuen Textfeld angezeigt.
7. Klicken Sie auf das Kopiersymbol oben rechts in diesem Feld, um den neuen SSH-Schlüssel zu kopieren. Klicken Sie noch nicht auf Installieren oder schließen Sie dieses Modal.
8. Gehen Sie nun zu den Einstellungen Ihres privaten GitHub-Repositorys (z. B. gehen Sie auf GitHub zu
Settings > Deploy keys).
9. Fügen Sie einen neuen Deploy-Key hinzu. Sie müssen ihm einen geeigneten Titel geben. Fügen Sie den SSH-Schlüssel, den Sie von Discourse kopiert haben, in das Deploy-Key-Feld ein.
10. Klicken Sie auf
Key hinzufügen, um den Deploy-Key in Ihren Git-Repository-Einstellungen zu speichern.
11. Kehren Sie zum Discourse-Theme-Installationsmodal zurück und klicken Sie auf die Schaltfläche
Installieren. Sie sollten nun die Einstellungsseite für Ihr neues Theme oder Ihre Komponente sehen.
Best Practices
- Verwenden Sie immer die SSH-URL für Ihr Repository, nicht die HTTPS-URL.
- Bewahren Sie Ihre Deploy-Keys sicher auf und geben Sie sie nicht öffentlich weiter.
- Aktualisieren Sie Ihre Themes oder Komponenten regelmäßig, um sicherzustellen, dass Sie die neuesten Funktionen und Sicherheitsupdates erhalten.
FAQs
F: Kann ich diese Methode mit anderen Git-Anbietern als GitHub verwenden?
A: Ja, diese Methode sollte mit jedem Git-Anbieter funktionieren, der Deploy-Keys oder SSH-Authentifizierung unterstützt.
F: Merkt sich Discourse den SSH-Schlüssel für zukünftige Updates?
A: Ja, Discourse speichert den generierten privaten Schlüssel und verwendet ihn für zukünftigen Zugriff auf das Git-Repository.
F: Kann ich das private Repository später ändern?
A: Ja, Sie können die Repository-URL bei Bedarf in den Theme-Einstellungen aktualisieren.
Zusätzliche Ressourcen
Die in diesem Thema verwendeten SSH-Schlüssel wurden nur für diese Dokumentation generiert