LiveConfig Hosting Modul

Aus Plambee.de Webhosting Wiki
Zur Navigation springen Zur Suche springen

Mit unserem LiveConfig Hosting Modul verbinden Sie Ihr WHMCS mit Ihrem LiveConfig Server. So werden Bestellungen von Webhosting Paketen automatisch auf dem LiveConfig Server angelegt.

Changelog

Den Changelog finden Sie der Übersichthalber ab sofort nur noch in unserem Dev Tracker. Dort können Sie auch Feature Requests einreichen.

Systemvoraussetzungen

Zur Nutzung des WHMCS Liveconfig Hosting Moduls müssen folgende Voraussetzungen erfüllt sein:

  • Lauffähige WHMCS Installation Version 7.5 - WHMCS 7.8
  • Admin Zugang zu WHMCS
  • FTP Zugang
  • installierter Ioncube Loader (mindestens Version 10.2)
  • PHP mind. in Version 5.6 mit SOAP
  • LiveConfig Server mit LiveConfig Standard oder Business (die Basic Version hat keine API)
  • Eingerichteter API Zugang auf dem LiveConfig Server

Installation

Modulinstallation

  • Loggen Sie sich bitte im Kundenbereich von Plambee.de Webhosting ein und laden sich dort die aktuelle Version des LiveConfig Hosting Moduls herunter.
  • Entpacken Sie die zip.Datei auf Ihrem Rechner
  • laden Sie die Ordner in Ihr WHMCS Verzeichnis.
  • Loggen Sie sich nun in Ihrem WHMCS Adminbereich ein
  • In der Addonauflistung suchen Sie nun bitte nach dem Modul „LiveConfig Hosting Modul“ und klicken dort bitte auf „Activate“ und danach auf „Configure“
  • In dem Feld „Module license“ tragen Sie bitte ihren Lizenzcode ein, diesen finden Sie im Plambee.de Kundenbereich in den Produktdetails.
  • Geben Sie nun bitte an welche Admingruppen Zugriff auf das Modul haben dürfen.

SOAP Passwort

Damit das Modul mit dem LiveConfig Server kommunizieren kann, ist es nötig das Sie einen Benutzer ein API Passwort anlegen. Generell kann man laut LiveConfig für jeden Benutzer (Benutzer != Kunde) ein API Kennwort anlegen. Die nötigen Befehle entnehmen Sie bitte dem Handbuch von LiveConfig

Produkt erstellen

Server anlegen

Gehen Sie im WHMCS Backend bitte nach Setup,Products/Services,Servers und legen dort einen neuen Server wie folgt an.

  • Name: Frei definierbarer Name
  • Hostname: der Hostname unter dem Ihr Server erreichbar ist z.b. liveconfigpanel.meinedomain.de
  • IP Address: Die IP Adresse ihres Servers
  • Assigned IP Addresses: kann leer bleiben oder Sie tragen hier weitere IP Adressen ein
  • Monthly Cost: Kann leer bleiben
  • Datacenter/NOC: Kann leer bleiben
  • Maximum No. of Accounts: Hier können Sie eintragen wie viele Accounts WHMCS drauf anlegen soll.
  • Enable/Disable: Ankreuzen um den Server verfügbar zu machen
  • Nameservers: In dieser Rubrik können Sie Nameserver hinterlegen
  • Type: Im Menü Type der Server Details wählen Sie bitte das "LiveConfig Hosting Module" aus
  • Username: Der Benutzername des SOAP-API Users
  • Password: Das Passwort des SOAP-API Users
  • Secure: Ankreuzen um sich via HTTPS zu verbinden (offizielles SSL Zertifikat für das LiveConfig Panel vorrausgesetzt)
  • Port: Standardmäßig läuft LiveConfig über den Port 8443, wenn Sie diesen geändert haben sollten, aktivieren Sie bitte die Checkbox und hinterlegen den Port
  • Test Connection: Wenn Sie alles eingegeben haben können Sie mit diesem Button die Verbindung testen. Werden Sie mit einem Hallo begrüßt ist alles ok und es kann gespeichert werden. Erhalten Sie eine Fehlermeldung überprüfen Sie bitte die Einstellungen.
  • Weisen Sie den Server nun eine Servergruppe zu.

Wenn Sie in LiveConfig eine Multiserver Umgebung haben, müssen Sie hier nur den Hauptserver Ihres Verbundes anlegen. Wenn Sie mehrere LiveConfig verbunde haben, können Sie für jeden Hauptserver des Verbundes einen Server in WHMCS anlegen.

Produkt erstellen

Gehen Sie im WHMCS Backend bitte nach Setup,Products/Services,Products/Services und erstellen Sie ein neues Hosting Produkt. Gehen Sie dann in das Tab "Module Settings" und wählen dort da LiveConfig Hosting Module aus und füllen die Felder bitte entsprechend aus.

  • Wählen Sie bitte die Servergruppe aus in welcher sich der eben erstellte Server befindet.
  • Angebotsname: Tragen Sie hier bitte den Namen des Webhosting Paketes, welches Sie in LiveConfig konfiguriert haben, ein mit dem dieses Produkt verknüpft werden soll. Achten Sie bitte dadrauf das die Schreibweise exakt übereinstimmen muss
  • Webserver: Wenn Sie eine Multiserver Umgebung haben tragen Sie hier bitte den Servernamen für den Webserver ein auf welchem der Vertrag erzeugt werden soll. Wird das Feld leergelassen wird localhost übergeben.
  • Mailserver: Wenn Sie eine Multiserver Umgebung haben tragen Sie hier bitte den Servernamen für den Mailserver ein auf welchem der Vertrag erzeugt werden soll. Wird das Feld leergelassen wird localhost übergeben.
  • Datenbankserver: Wenn Sie eine Multiserver Umgebung haben tragen Sie hier bitte den Servernamen für den Datenbankserver ein auf welchem der Vertrag erzeugt werden soll. Wird das Feld leergelassen wird localhost übergeben.
  • Präfix: Hier können Sie einen Präfix eingeben welcher bei der Defaultdomain, der Vertrags- und Userbezeichnung verwendet wird. Z.B. web
  • DNS-Template: Wenn Sie Ihren Nameserver von LiveConfig verwalten lassen, geben Sie hier bitte das DNS Template für die Domain an
  • IP-Group: Wenn Sie der bei der Bestellung mit angegebenen Domain einer speziellen IP-Gruppe zuordnen können geben Sie hier bitte den Namen an
  • Reseller?: Wenn es sich um einen Reseller Tarif handelt, aktivieren Sie bitte diese Checkbox, da Reseller in LiveCOnfig keinen eigenen FTP Zugang in diesem Tarif haben wird damit die Darstellung der FTP Zugangsdaten im Kundenbereich deaktiviert.

Wenn Sie alles eingestellt haben können Sie das Produkt speichern.

Moduleinstellungen

Gehen Sie als nächstes bitte in das Modul und Klicken dort auf Einstellungen und geben Sie dort nun bitte an ob eine Standarddomain erstellt werden soll, die Anbieterdomain und einen Admin. Bitte wählen Sie auch aus ob für den in LiveConfig angelegten Kunden die WHMCS Kundennummer verwendet werden soll oder die Einstellung in LiveConfig.

Config Options

Das Modul unterstützt auch die WHMCS Funktion der Konfig Options, so können die Kunden z.B. einzelne Parameter erweitern. Wenn Sie nicht möchten das die Kunden einzelne Parameter ändern können müssen Sie keine Config Options konfigurieren, der Vertrag wird dann immer mit den Standardwerten welche Sie in LiveConfig hinterlegt haben erstellt.
Um Config Options zu erstellen gehen Sie bitte wie folgt vor:

Beispiel der Config Option

Gehen Sie im WHMCS Backend nach Setup,Products/Services, Configurable Option und erstellen dort einen neuen Eintrag. Im Feld "Group Name" tragen Sie den Namen ein, z.B. den Namen des zugeordneten Produkt, bei Description eine Kurzbeschreibung und bei Assigned Products das Produkt zu dem diese Optionen zugeordnet werden sollen. Nach dem Speichern können Sie mit dem Button "Add new Configurable Option" eine neue Option erstellen. Bei Option Name geben Sie den Namen der Option an, z.B. webspace und bei "Add Option" die Option. Die Option können in folgendem Format eingetragen werden WERT|Anzuzeigener Text d.h. bei WERT kommt der Wert hin den das Modul benötigt z.B. 250 und bei Anzuzeigener Text können Sie den Text eingeben welcher dem Kunden dann angezeigt wird also z.B. 250MB Webspace.

Hinweis: Wenn Sie mit Config Options arbeiten möchten erstellen Sie die 1. Config Options bitte immer mit dem Standardwert welchen Sie im LiveConfig Angebot hinterlegt haben und setzen den Preis bei dieser Option auf 0€. Alle weiteren Optionen können dann mit Preisen versehen werden.
Ein Beispiel entnehmen Sie bitte dem Bild "Beispiel der Config Option"


folgende Optionen stehen Ihnen zur Verfügung

Name der Option Beispiel Beschreibung Format/Sonstiges
webserver localhost|Standard Wenn Sie eine Multiserver Umgebung haben können Sie den Kunden mit dieser Option die Wahl geben auf welchem Server seine Webseite laufen soll. So können Sie z.B. auch unterschiedliche Standorte (Deutschland, Frankreich) anbieten. Angegeben muss entweder localhost oder der Name des Servers. Diese Option überschreibt dann den im Produkt voreingestellten Webserver. Als Option Type empfehlen wir Dropdown
mailserver localhost|Standard Wenn Sie eine Multiserver Umgebung haben können Sie den Kunden mit dieser Option die Wahl geben über welchem Server seine E-Mails laufen sollen. So können Sie z.B. auch unterschiedliche Standorte (Deutschland, Frankreich) anbieten. Angegeben muss entweder localhost oder der Name des Servers. Diese Option überschreibt dann den im Produkt voreingestellten Mailservers. Als Option Type empfehlen wir Dropdown
dbserver localhost|Standard Wenn Sie eine Multiserver Umgebung haben können Sie den Kunden mit dieser Option die Wahl geben auf welchem Server seine Datenbanken laufen sollen. So können Sie z.B. auch unterschiedliche Standorte (Deutschland, Frankreich) anbieten. Angegeben muss entweder localhost oder der Name des Servers. Diese Option überschreibt dann den im Produkt voreingestellten Mailservers. Als Option Type empfehlen wir Dropdown
maxcustomers 5|5 Kunden Maximale Kundenanzahl für Reseller Die Eingabe von -1 entspricht einer unbegrenzten Anzahl von Kunden
maxusers 5|5 Benutzer Anzahl der Benutzer die der Kunde anlegen darf Muss mindestens 1 sein, Die Eingabe von -1 entspricht einer unbegrenzten Anzahl von Kunden
webspace 250|250 MB Gibt an wie viel Webspace der Kunde in seinem Vertag haben darf die Angabe erfolgt in MB, die Eingabe von -1 entspricht einem unbegrenztem Webspace
ssi on|Kein SSI ermöglicht dem Kunden die Wahl ob er SSI nutzen möchte oder nicht Option Type: YES/NO, Werte on oder off.
php 0|kein PHP erlaubt lässt dem Kunden die Wahl ob er PHP nutzen möchte und welche Umsetzung Option Type: Dropdown, 0= Kein PHP erlaubt, 1=suPHP, 2=FastCGI, 3=mod_php
cgi on|Kein CGI ermöglicht dem Kunden die Wahl ob er CGI nutzen möchte oder nicht Option Type: YES/NO, Werte on oder off.
ssl 0|Kein SSL ermöglicht dem Kunden die Wahl ob SSL zur Verfügung steht oder nicht Option Type: Dropdown, 0=Nein, 1=ja, 2=ja mit Zertifikatsverwaltung
cronjobs 5|5Cronjobs Gibt an wie viele Cronjobs dem Kunden zur Verfügung stehen Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Anzahl von Cronjobs
apps 5|5 Anwendungen Gibt an wie viele vom Installer installierte Apps der Kunde gleichzeitig nutzen darf Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Anzahl von Apps
ftpaccounts 5|5 FTP Zugänge Gibt an wie viele FTP Accounts der Kunde maximal erstellen kann Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Anzahl von FTP Accounts
shellaccess 0|kein Shellzugang Gibt an ob der Kunde Zugang zur Shell haben kann Option Type: Dropdown, 0=Nein, 1=scponly/sftp, 2=ja (bash)
databases 5|5 Datenbanken Gibt an wie viele Datenbanken der Kunde haben kann Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Anzahl von Datenbanken
subdomains 50|50 Subdomains Gibt an wie viele Subdomains der Kunde anlegen kann Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Anzahl von Subdomains
extdomains 50|50 externe Domains Gibt an wie viele externe Domains der Kunde anlegen kann Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Anzahl von externen Domains
mailboxes 5|5 E-Mail Postfächer Gibt an wie viele E-Mail Postfächer der Kunde anlegen kann Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Anzahl von E-Mail Postfächern
mailaddrs 5|5 E-Mail Adressen Gibt an wie viele E-Mail Adressen der Kunde anlegen kann Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Anzahl von E-Mail Adressen
mailquota 250|250 MB E-Mail Speicher Gibt an wieviel Speicherplatz dem Kunden für E-Mails zur Verfügung stehen Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Höhe von Speicherplatz. Eingabewert sind MB
traffic 250|250 MB Traffic Gibt an wieviel Traffic dem Kunden zur Verfügung steht Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Höhe von Traffic. Eingabewert sind MB
webstats 0|keine Webstatistiken Gibt an welche Webstatistik dem Kunden zur Verfügung steht Option Type: Dropdown, 0=keine, 1=Webalizer, 2=AWStats
memory_limit 256m|256 MB Memory Limit PHP Memory Limit Option Type: Dropdown

k = Kilobyte, m=Megabyte, g=Gigabyte

post_max_size 30m|30 MB Post Size Post Max Size Option Type: Dropdown

k = Kilobyte, m=Megabyte, g=Gigabyte

upload_max_filesize 30m|30 MB Upload Limit Upload Max Filesize Option Type: Dropdown

k = Kilobyte, m=Megabyte, g=Gigabyte

max_execution_time 60|60 Sekunden MAX Execution time Option Type: Dropdown

Es ist nicht nötig alle Config Options zu hinterlegen. Für Werte für die Sie keine Configoptions erstellen (z.B. wenn Sie die Wahl von SSI weglassen) werden die Standards des in Liveconfig konfigurirten Angebots verwendet.

Update Hinweise

Update auf Version 1.9.0

Mit Version 1.9.0 werden die globalen Subdomaineinstellungen in die einzelnen Produkte überführt. Hierbei werden Ihre bisherigen Einstellungen migriert. Laden Sie bitte alle Moduldateien hoch und gehen dann in das LiveConfig Hosting Modul um das Upgrade auf Version 1.9.0 durchzuführen. Konfigurieren Sie dann erst Ihre Produkte. Sollten Sie erst Ihre Produkte konfigurieren und dann das Modul aufrufen würden Ihre Einstellungen überschrieben.

Update Auf Version 2.0.0

Mit Version 2.0 wird LiveConfig in der Version 2.8 unterstützt. Mit dieser Version hat LiveConfig die API für PHP.ini Werte erweitert. Um dieses Feature zu nutzten müssen weitere ConfigOptions angelegt werden, die Werte hierfür finden Sie im entsprechenden Abschnitt der Dokumentation.

Informationen zu den Templatedateien

Mit Version 1.2.0 wurde der Kundenbereich des Moduls deutlich erweitert. So kann der Kunde nun bestimmte Aktionen direkt aus Ihrem WHMCS Kundenbereich heraus durchführen. Die Templatedateien sind selbstverständlich individuell anpassbar, Sie finden diese im Verzeichnis /modules/servers/liveconfig_hosting_mod/templates/ .

subdomain.tpl

Bei der Templatedatei subdomain.tpl arbeiten wir für das Selectmenü mit der Erweiterung Bootstrap Select (https://silviomoreto.github.io/bootstrap-select/) um dem Kunden das Einstellen mit der integrierten Suche zu erleichtern, auf der Produktseite finden Sie wietere Konfigurationsmöglichkeiten für dieses Menü.

Importer für die LiveConfig Hosting Suite

Das Modul besitzt eine Importfunktion und bestehende Hostingprodukte in unser LiveConfig Hosting Modul zu importieren. Wichtig ist das Sie den Präfix genauso übernehmen wie er aktuell ist.
Um bestehende Produkte zu importieren erstellen Sie bitte als erstes ein Backup Ihrer WHMCS Datenbank, stellen Sie dann bitte sicher das die LiveConfig Hosting Suite und unser LiveConfig Hosting Modul in Ihrem WHMCS aktiv sind.
Gehen Sie dann in unser Modul in die Einstellungen und klicken dort auf den Button um den Import zu starten.
Sobald Sie die Information erhalten das die Daten erfolgreich importiert werden konnten gehen Sie bitte in die Servereinstellung von WHMCS und wechseln bei Ihrem LiveConfig Server bitte auf unser Modul und geben in die dafür vorgesehenen Felder den Benutzernamen und das Passwort für die API ein. Danach gehen Sie bitte in die Produkteinstellungen von WHMCS (gemeint ist hier nicht das Produkt der Kunden sondern die Seite /admin/configproducts.php) und ändern dort unter dem Punkt Module Setting das zuständige Modul in dem DropDowon Menü auf "LiveConfig Hosting Modul" und nehmen dann die Einstellungen vor und speichern das ganze. Dies machen Sie bitte bei allen Produkten.
Testen Sie nun bitte bei den jeweiligen Kundenprodukten ob die Daten korrekt übernommen wurden, wenn alles korrekt ist können Sie die LiveConfig Hosting Suite deaktivieren. Sollte der Import nicht erfolgreich gewesen sein, leeren Sie bitte die mod_pl_liveconfig_hosting Datenbanktabelle und versuchen Sie es erneut oder wenden Sie sich an unseren Support.

Der Importer führt in den Tabellen der LiveConfig Hosting Suite keine Schreibvorgänge aus und baut auch keinerlei Verbindung zu Ihrem LiveConfig Server auf.
Der Importer ist mit Version 1.12 der Hosting Suite kompatibel.
Denken Sie bitte auch daran die Configoptions zu überprüfen und ggf. anzupassen.

Template Variablen

E-Mail Template

Nach erfolgreicher Erstellung des Produktes kann WHMCS dem Kunden eine Willkommensnachricht zusenden in welcher er über die Erstellung informiert wird. Standardmäßig verwendet man hierfür das E-Mail Template Hosting Account Welcome Email. Beachten Sie hierzu aber bitte folgendes:
Die Variable {$service_password} gibt das FTP Passwort aus und die Variable {$lhm_lc_pw} das Passwort für den LiveConfig Account und die Variable {$service_username} gibt die Vertragsbezeichnung aus. Wenn Sie die Kundennummer aus LiveConfig verwenden können Sie diese über die Variable {$lhm_lc_kid} ausgeben lassen. Ab Version 1.3.0 steht Ihnen mit der Variablen {$lhm_lc_userid} die Darstellung des LiveConfig Benutzernamens zur Verfügung.

Hinweise

Sperrungen

Ab Version 2.3.0 ist LiveConfig in der Lage einzelne Accounts und nicht nur ganze Accounts zu sperren. Sollten Sie Liveconfig in einer Version älter als 2.3.0 verwenden seien Sie sich beim Sperren also bitte bewusst das dem Kunden der komplette LiveConfig Account gesperrt wird und dadurch auch andere des Kundens Verträge betroffen sind.
Wenn Sie LiveConfig in Version >= 2.3.0 verwenden sperrt das Modul (ab Version 1.3.0) immer nur den jeweiligen Vertrag. Wenn Sie die normale Suspend Funktion von WHMCS verwenden werden alle Dienste (Web, Mail und FTP) deaktiviert. Sollten Sie nur einzelne Dienste sperren wollen dann können Sie dies über die neuen Buttons in der Produktansicht im Adminbereich machen.
Klicken Sie z.B. auf Suspend Webspace wird der Webspace des Vertrages gesperrt, drücken Sie nun zusätzlich auf Suspend FTP wird der FTP Account zusätzlich zum bereits gesperrten Webspace gesperrt. Nach dem selben Prinzip funktioniert auch das entsperren.
So können Sie dem Kunden z.B. den FTP Zugang freigeben damit er seine Seite reparieren kann, Web und Mail bleiben aber weiterhin gesperrt bis die Seite wieder sauber ist.

Resellerverträge

Wenn Sie im Feld "Angebot" einen Resellervertrag angeben wird beim Hosting Vertrag in LiveConfig keine Domain mit übergeben und dem Vertrag zugeteilt.

Zudem dürfen Sie die Config-Option maxcustomers nur bei Resellerverträgen verwenden.

manuelle Produktzuweisung

Wenn Sie bereits einen LiveConfig Server betreiben und bestehende Verträge nun mit WHMCS verwalten möchten können Sie diese ab Modulversion 1.2.0 manuell miteinander verknüpfen. Gehen Sie dafür bitte wie folgt vor:

  • Erstellen Sie beim jeweiligen Kunden ein Produkt welches dem LiveConfig Paket entspricht

Legen Sie hierzu in WHMCS manuell eine Bestellung an, setzen sie dafür den Status auf active und deaktivieren Sie das Kästchen für die das senden der E-Mail.

  • Gehen Sie nun im Adminbereich in das Produkt und hinterlegen dort die Subscription, die Kundenummer des Kunden (die Kundennummer die der Kunde in LiveConfig hat) und den Benutzernamen des Kunden. Die Subscription entspricht der Vertragsbezeichnung in LiveConfig also z.B. web56 und der Benutzername entspricht dem Anmeldename welchen der Kunde einträgt um sich in LiveConfig einzuloggen
  • Klicken Sie nun auf Speichern
  • Klicken Sie nun auf den Button „Import Product“. Durch den Klick auf „Import Product“ wird nun die LiveConfig API mit unterschiedlichen Befehlen aufgerufen um die nötigen Daten auszulesen. Ausgelesen wird die Kontakt-ID und die Kunden-ID, diese werden später z.B. für das Ändern des Kontaktes benötigt.
  • Nach dem erfolgreichen Import werden Ihnen nun die Felder LiveConfig ContactID und LiveConfig ClientID ausgefüllt.

Damit enthält das WHMCS Produkt nun alle nötigen Informationen damit der Kunde seinen LiveConfig Account über WHMCS verwalten kann. Wiederholen Sie dies bitte für jedes Produkt.