KeyHelp-Manager-for-WHMCS/QUICKSTART.md

KeyHelp Manager v2.0 - Schnellstart-Anleitung

Dieses Dokument beschreibt die schnellste Methode, um KeyHelp Manager v2.0 in WHMCS zu konfigurieren.

⏱️ Geschätzte Zeit: 10 Minuten

---

🚀 In 5 Schritten zum fertigen Setup

Schritt 1: Module hochladen (2 Min.)

# Entpacke das Modul in dein WHMCS-Verzeichnis
unzip keyhelpmanager.zip -d /pfad/zu/whmcs/modules/servers/

Oder manuell:

1. Entpacke keyhelpmanager.zip
2. Lade den Ordner keyhelpmanager nach modules/servers/ hoch

Schritt 2: Server in WHMCS konfigurieren (3 Min.)

1. Gehe zu: Setup → Products/Services → Servers
2. Klicke: Add New Server
3. Fülle aus:

Name:              KeyHelp Server 1
Hostname:          keyhelp.example.com (oder IP: 5.83.148.129)
Type:              KeyHelp Manager
Password:          [DEIN-API-KEY-HIER]
Secure (SSL):      ✓ (aktivieren)
Active:            ✓ (aktivieren)
HTTP Prefix:       [leer lassen - bei IP automatisch]

💡 SSL-Hinweis:

• Bei IP-Adresse (z.B. 5.83.148.129): SSL-Verifizierung wird automatisch deaktiviert
• Bei Domain (z.B. keyhelp.example.com): Stelle sicher, dass ein gültiges SSL-Zertifikat installiert ist
• Bei selbstsigniertem Zertifikat: Trage no-verify im Feld "HTTP Prefix" ein

4. Klicke: Test Connection → "Connection Successful!" ✅
5. Speichern: Save Changes

Schritt 3: Produkt erstellen (2 Min.)

1. Gehe zu: Setup → Products/Services → Products/Services
2. Wähle eine Produktgruppe oder erstelle eine neue
3. Klicke: Create a New Product
4. Fülle aus:

Product Type:      Hosting Account
Product Name:      Webhosting Basic

5. Tab: Module Settings
6. Wähle:
   • Module Name: KeyHelp Manager
   • Server Group: oder Selected Server: KeyHelp Server 1

Schritt 4: Templates synchronisieren (1 Min.)

1. In den Module Settings (gleiche Seite)
2. Klicke: Sync Templates (Button oben)
3. Nach 2-3 Sekunden: Dropdown wird mit Templates gefüllt
4. Wähle bei KeyHelp Template: dein gewünschtes Template
   • z.B. "Basic Plan", "Pro Plan", etc.
5. Speichern: Save Changes

Schritt 5: Test durchführen (2 Min.)

1. Erstelle eine Test-Bestellung für das Produkt
2. Markiere als bezahlt
3. Prüfe:
   • ✅ Account wird in KeyHelp erstellt
   • ✅ Client Area zeigt Login-Daten
   • ✅ Template-Name wird angezeigt
   • ✅ Statistiken werden geladen
   • ✅ Login-Button funktioniert

Fertig! 🎉

---

🎯 Wichtigste Unterschiede zu v1.x

v1.x (Alt)	v2.0 (Neu)
API-Key in jedem Produkt	API-Key nur einmal im Server
Hostname in jedem Produkt	Hostname nur einmal im Server
Manuelle Plan-Eingabe	Automatisches Template-Dropdown
Keine Template-Info	Template wird im Client Area angezeigt

Vorteil: Bei 10 Produkten spart man 90% Konfigurationsaufwand!

---

💡 Typische Szenarien

Szenario A: Ein Server, mehrere Produkte

Server in WHMCS:
└── KeyHelp Server 1 (keyhelp.example.com)

Produkte:
├── Webhosting Basic    → Server 1, Template "Basic"
├── Webhosting Pro      → Server 1, Template "Pro"
├── Webhosting Business → Server 1, Template "Business"
└── Reseller Paket      → Server 1, Template "Reseller"

Konfiguration:

1. Einen Server anlegen
2. Bei jedem Produkt: Server zuweisen + Template wählen

Szenario B: Mehrere Server

Server in WHMCS:
├── KeyHelp Server 1 (Shared Hosting)
├── KeyHelp Server 2 (Reseller)
└── KeyHelp Server 3 (VPS)

Produkte nach Server zuweisen

Konfiguration:

1. Alle Server in WHMCS anlegen
2. Produkte dem passenden Server zuweisen
3. Templates synchronisieren
4. Template pro Produkt wählen

---

🔑 API-Key erstellen (KeyHelp)

Falls du noch keinen API-Key hast:

1. Login in KeyHelp als Admin
2. Gehe zu: Einstellungen → API
3. Klicke: API-Schlüssel erstellen
4. Name: WHMCS Integration
5. Rechte: Admin (alle Rechte)
6. Kopiere den generierten Key
7. Verwende ihn im WHMCS Server-Setup

Wichtig: Der Key wird nur einmal angezeigt!

---

✅ Checkliste

Bevor du loslegst:

• WHMCS 8.13+ installiert
• PHP 8.3+ verfügbar
• KeyHelp-Server läuft
• API-Key erstellt
• Pläne/Templates in KeyHelp angelegt
• FTP/SSH-Zugang zu WHMCS-Server

Nach der Installation:

• Server in WHMCS konfiguriert
• Test Connection erfolgreich
• Mindestens ein Produkt erstellt
• Templates synchronisiert
• Template ausgewählt
• Test-Bestellung erfolgreich
• Client Area funktioniert
• Login funktioniert

---

🔧 Verfügbare Templates laden

Templates werden von KeyHelp geladen. Stelle sicher, dass in KeyHelp Pläne angelegt sind:

In KeyHelp:

1. Einstellungen → Pläne
2. Erstelle Pläne wie:
   • Basic Plan (5 GB, 1 Domain)
   • Pro Plan (20 GB, 10 Domains)
   • Business Plan (100 GB, unlimitiert)

Diese erscheinen dann automatisch im WHMCS-Dropdown!

---

🎨 Client Area Features

Nach der Erstellung sehen Kunden:

┌─────────────────────────────────────────┐
│  KeyHelp Hosting                ACTIVE  │
│  example.com      📋 Basic Plan         │
│                                         │
│  [Open Control Panel] [Admin Panel]    │
└─────────────────────────────────────────┘

┌─────────────────┬───────────────────────┐
│  Username       │  Password             │
│  example_com    │  ••••••••  👁️ 📋     │
└─────────────────┴───────────────────────┘

📊 Resource Usage
┌─────────────────────────────────────────┐
│ 💾 Disk Space:  2.3 GB / 5 GB          │
│ ▓▓▓▓▓▓▒░░░░░░░░░ 46%                   │
│                                         │
│ 📊 Bandwidth:   15 GB / 100 GB         │
│ ▓▓▒░░░░░░░░░░░░░ 15%                   │
└─────────────────────────────────────────┘

┌───────┬──────────┬────────────┐
│   3   │    2     │     5      │
│ 🌐 Domains │ 🗄️ DBs  │ 📧 Emails │
└───────┴──────────┴────────────┘

---

🐛 Schnelle Problemlösungen

"KeyHelp server not configured"

→ Server in WHMCS anlegen und Produkt zuweisen

Templates werden nicht geladen

→ Test Connection durchführen, dann Sync Templates klicken

"Connection failed"

→ Hostname, API-Key und SSL-Einstellungen prüfen

"cURL error 60: SSL certificate problem"

→ Bei IP-Adresse: Wird automatisch gelöst! → Bei selbstsigniertem Zertifikat: "no-verify" im HTTP Prefix eintragen → Details: SSL_TROUBLESHOOTING.md

API-Key funktioniert nicht

→ In KeyHelp prüfen: Key hat Admin-Rechte?

Template-Dropdown leer

→ In KeyHelp: Sind Pläne angelegt?

---

📚 Weiterführende Dokumentation

• Installation: INSTALLATION.md - Detaillierte Schritt-für-Schritt-Anleitung
• Update: UPDATE.md - Migration von v1.x auf v2.0
• Changelog: CHANGELOG.md - Alle Änderungen und Features
• Support: GitHub Issues oder https://avvgo.de

---

💬 Häufige Fragen

Muss ich API-Keys für jedes Produkt eingeben?

Nein! Das ist der große Vorteil von v2.0. API-Key nur einmal beim Server.

Kann ich mehrere KeyHelp-Server nutzen?

Ja! Lege einfach mehrere Server in WHMCS an.

Funktionieren alte Accounts nach dem Update?

Ja! Bestehende Accounts funktionieren weiterhin ohne Änderungen.

Kann ich eine IP-Adresse statt Domain verwenden?

Ja! Das Modul erkennt IP-Adressen automatisch und deaktiviert die SSL-Verifizierung.

Kann ich Templates nachträglich ändern?

Ja! Einfach in der Produktkonfiguration ändern und speichern.

Was passiert, wenn ich ein Template lösche?

Templates nur in KeyHelp löschen, wenn keine aktiven Accounts damit verbunden sind.

Wo finde ich die Module-Logs?

Utilities → Logs → Module Log → Filter: "keyhelpmanager"

---

🎯 Pro-Tipps

1. Template-Namen sinnvoll wählen

   • ✅ "Basic Plan", "Pro Plan", "Business Plan"
   • ❌ "Plan1", "Plan2", "Plan3"

2. Server-Namen beschreibend

   • ✅ "KeyHelp Main", "KeyHelp Reseller"
   • ❌ "Server1", "Test123"

3. SSL immer aktivieren

   • Sicher und empfohlen!

4. IP vs. Domain für Hostname

   • 🧪 Entwicklung/Test: IP-Adresse ist OK (SSL-Check automatisch aus)
   • 🚀 Produktion: Domain mit gültigem SSL-Zertifikat (Let's Encrypt)

5. Templates regelmäßig synchronisieren

   • Nach Änderungen in KeyHelp: Sync klicken

6. Test-Account behalten

   • Zum schnellen Testen von Änderungen

---

🚀 Nächste Schritte

Nach dem Setup:

1. ✅ Weitere Produkte anlegen
2. ✅ Preise und Beschreibungen anpassen
3. ✅ Kunden-E-Mail-Templates konfigurieren
4. ✅ Automatisierung testen
5. ✅ Team schulen
6. ✅ Live gehen!

---

📞 Support & Updates

• Website: https://avvgo.de
• Entwickler: Kevin Feiler
• Version: 2.0.0
• Lizenz: MIT

Viel Erfolg mit KeyHelp Manager! 🎉

---

Letzte Aktualisierung: 2024-01-20