GitHub Installer

Bidirektionale GitHub-Integration für REDAXO - Installiere Module, Templates und Classes aus GitHub-Repositories und lade deine eigenen Inhalte zu GitHub hoch.

🚀 Features

📥 Installation von GitHub

• Browse und installiere Module/Templates/Classes aus GitHub-Repositories
• Asset-Unterstützung: CSS/JS-Dateien werden automatisch kopiert nach /assets/modules/{key}/ bzw. /assets/templates/{key}/
• Class-Support: PHP-Classes werden nach project/lib/ installiert mit Verzeichnis-Struktur
• File-basiertes Caching für bessere Performance
• Unterstützung für private Repositories mit GitHub-Tokens
• Multi-Language Support (Deutsch/Englisch)
• Sauberes Repository-Management

📤 Upload zu GitHub

• Bidirektionale Synchronisation: Lade deine lokalen REDAXO Module/Templates/Classes zu GitHub hoch
• Settings-Integration: Einmalige Repository-Konfiguration (Owner, Repository, Branch, Author)
• Intelligente Ordnernamenerkennung: Verwendet Modul-Keys (z.B. "gblock") statt IDs
• Vollständiger Upload: input.php, output.php, config.yml, README.md werden automatisch generiert
• Class-Upload: PHP-Classes aus project/lib/ mit Verzeichnis-Struktur
• Überschreiben: Vorhandene Module/Templates/Classes werden aktualisiert

📁 Repository-Struktur

Dein GitHub-Repository sollte folgende Struktur haben:

repository/
├── modules/
│   └── module_key/              # z.B. "gblock", "text-simple"
│       ├── config.yml           # Modul-Konfiguration
│       ├── input.php            # Eingabe-Template
│       ├── output.php           # Ausgabe-Template
│       ├── README.md            # Dokumentation (optional)
│       └── assets/              # CSS/JS-Dateien (optional)
│           ├── styles.css
│           └── script.js
├── templates/
│   └── template_key/            # z.B. "main-layout"
│       ├── config.yml           # Template-Konfiguration
│       ├── template.php         # Template-Inhalt
│       ├── README.md            # Dokumentation (optional)  
│       └── assets/              # CSS/JS-Dateien (optional)
│           ├── template.css
│           └── template.js
└── classes/
    ├── SimpleClass.php          # Einzelne Class-Datei
    ├── SimpleClass.md           # Dokumentation (optional)
    └── ComplexClass/            # Class mit Verzeichnis-Struktur
        ├── ComplexClass.php     # Haupt-Class-Datei
        ├── README.md            # Dokumentation (optional)
        └── config.yml           # Class-Konfiguration (optional)

📝 config.yml Format

Module Konfiguration

title: "01 - Gridblock (gruppierte Blöcke)"
description: "Flexibles Spaltenraster-System für REDAXO"
author: "Falko Müller"
version: "1.0.0"
redaxo_version: "5.13+"

Template Konfiguration

title: "Main Layout Template"
description: "Basis-Layout für die Website"
author: "Developer Name"
version: "1.2.0"
redaxo_version: "5.13+"

Class Konfiguration

title: "Demo Helper Class"
description: "Hilfsklasse für Demo-Funktionen"
author: "Developer Name"
version: "1.0.0"
redaxo_version: "5.13+"
namespace: "Demo"

🛠️ Installation & Konfiguration

1. Addon installieren

1. GitHub Installer in REDAXO installieren
2. Addon aktivieren

2. Upload-Einstellungen konfigurieren (optional)

Für das Hochladen zu GitHub:

1. Backend → Addons → GitHub Installer → Einstellungen
2. Upload-Repository konfigurieren:
   • Owner: Dein GitHub-Username (z.B. skerbis)
   • Repository: Repository-Name (z.B. stuff)
   • Branch: Ziel-Branch (z.B. main)
   • Author: Dein Name für die Metadaten

3. GitHub-Token konfigurieren (optional, aber empfohlen)

Wann wird ein Token benötigt?

• Private Repositories: Zugriff auf nicht-öffentliche Repositories
• Höhere Rate-Limits: GitHub erlaubt mehr API-Anfragen mit Token
• Upload-Funktionalität: Zum Hochladen von Modulen/Templates/Classes zu GitHub

Token erstellen

1. GitHub → Settings → Developer settings → Personal access tokens → Fine-grained tokens

2. Generate new token

3. Token-Name vergeben (z.B. "REDAXO GitHub Installer")

4. Repository access auswählen:

   • All repositories (für alle Repositories) oder
   • Only select repositories (für bestimmte Repositories)

5. Erforderliche Berechtigungen auswählen:

   Repository permissions:

   Nur zum Installieren (Lesen):

   • ✅ Contents: Read-only (Repository-Inhalte lesen)
   • ✅ Metadata: Read-only (automatisch gesetzt)

   Zum Installieren UND Hochladen:

   • ✅ Contents: Read and write (Repository-Inhalte lesen und schreiben)
   • ✅ Metadata: Read-only (automatisch gesetzt)

   Alle anderen Berechtigungen sind NICHT erforderlich:

   • ❌ Actions
   • ❌ Administration
   • ❌ Codespaces
   • ❌ Commit statuses
   • ❌ Discussions
   • ❌ Environments
   • ❌ Issues
   • ❌ Pull requests
   • ❌ etc.

6. Expiration festlegen (empfohlen: 90 Tage oder weniger)

7. Token generieren und sofort kopieren (wird nur einmal angezeigt!)

8. Token in REDAXO einfügen: Backend → Addons → GitHub Installer → Einstellungen

Sicherheitshinweise

• ⚠️ Token niemals öffentlich teilen oder in Code committen
• 🔒 Token mit minimalen Berechtigungen erstellen
• 🔄 Token regelmäßig erneuern (Ablaufdatum setzen)
• 🗑️ Ungenutzte Token löschen

🎯 Verwendung

Module/Templates/Classes installieren

1. Backend → Addons → GitHub Installer → Installieren (Module/Templates/Classes)
2. Repository hinzufügen (z.B. username/repository)
3. Verfügbare Module/Templates/Classes durchsuchen
4. Installieren oder Neu laden klicken
5. Assets werden automatisch nach /assets/modules/{key}/ kopiert
6. Classes werden nach project/lib/ installiert (mit Verzeichnis-Struktur)

Module/Templates/Classes hochladen

1. Backend → Addons → GitHub Installer → Upload
2. Modul, Template oder Class aus der Liste auswählen
3. Upload klicken
4. Beschreibung und Version eingeben
5. Das System erstellt automatisch:
   • Module: /modules/{key}/config.yml, input.php, output.php, README.md
   • Templates: /templates/{key}/config.yml, template.php, README.md
   • Classes: /classes/{classname}.php oder /classes/{classname}/ mit Struktur

🔧 Asset-Management

Das Addon unterstützt automatisches Asset-Management:

• Bei Installation: CSS/JS-Dateien werden von {repository}/modules/{key}/assets/ nach /assets/modules/{key}/ kopiert
• Bei Upload: Lokale Assets werden automatisch mit hochgeladen
• Unterstützte Dateien: .css, .js, .scss, .less, .jpg, .png, .gif, .svg, etc.

🎨 Beispiel-Repository

Siehe: https://github.com/skerbis/stuff

stuff/
├── modules/
│   ├── gblock/
│   │   ├── config.yml
│   │   ├── input.php
│   │   ├── output.php
│   │   └── assets/
│   │       └── gblock.css
│   └── text-simple/
│       ├── config.yml
│       ├── input.php
│       └── output.php
├── templates/
│   └── main-layout/
│       ├── config.yml
│       ├── template.php
│       └── assets/
│           ├── layout.css
│           └── layout.js
└── classes/
    ├── SimpleHelper.php
    └── DemoHelper/
        ├── DemoHelper.php
        ├── README.md
        └── config.yml

🆕 Changelog

Version 1.3.0

• ✅ Class-Support: Vollständige Unterstützung für PHP-Classes
• ✅ Verzeichnis-Struktur: Classes werden mit korrekter Ordner-Struktur installiert
• ✅ Architecture-Refactor: Getrennte Install- und Update-Manager
• ✅ UI-Verbesserungen: Konsistente Benutzeroberfläche für alle Typen
• ✅ Terminologie: "Neu laden" statt "Aktualisieren" für bessere Klarheit

Version 1.2.0

• ✅ Bidirektionale Synchronisation: Upload-Funktionalität hinzugefügt
• ✅ Asset-Unterstützung: Automatisches Kopieren von CSS/JS-Dateien
• ✅ Settings-Integration: Repository-Konfiguration im Backend
• ✅ Intelligente Ordnernamen: Verwendet Modul-Keys statt IDs
• ✅ Vollständiger Upload: Automatische Generierung von config.yml und README.md

Version 1.1.0

• ✅ Asset-Installation: CSS/JS-Dateien werden automatisch kopiert
• ✅ Verbesserte UI: Bessere Darstellung von Modulen mit Assets
• ✅ Cache-Optimierung: Schnellere Repository-Browsing

Version 1.0.0

• ✅ Basis-Installation: Module und Templates aus GitHub installieren
• ✅ Repository-Management: GitHub-Repositories verwalten
• ✅ Multi-Language: Deutsch/Englisch Support