Zum Inhalt springen

Dokumentation

Installation

So kommt GratOrder in deine Contao-Website. Du brauchst dafür die Lizenzmail mit deinem Lizenzschlüssel und FTP-Zugang zu deiner Installation. Lieber gar nicht selbst installieren? Dann nimm das Paket Mit Einrichtung, wir erledigen alles für dich.

1. Voraussetzungen

  • Contao 5.7 (Managed Edition) mit Contao Manager oder Composer
  • PHP 8.3 oder neuer
  • FTP- oder SFTP-Zugang zum Hauptverzeichnis der Installation (dort, wo auch der Ordner vendor liegt)
  • Ein Cronjob beim Hoster, der jede Minute laufen darf

Das Notification Center für die Bestellmails wird automatisch mitinstalliert.

2. Zugang einrichten

GratOrder kommt nicht aus dem öffentlichen Paketverzeichnis, sondern aus unserem eigenen Composer-Repository. Dafür ergänzt du zwei Dateien im Hauptverzeichnis deiner Installation.

composer.json: Trage das Repository ein und nimm GratOrder in require auf. Steht dort schon ein Abschnitt repositories, ergänze nur den neuen Eintrag; achte auf die Kommas.

"repositories": [
    {
        "type": "composer",
        "url": "https://www.gratorder.de/composer"
    }
],
"require": {
    ...
    "gratlinie/contao-gratorder": "0.*"
}

auth.json: Lege die Datei neu an oder ergänze sie. Benutzername ist die E-Mail-Adresse aus der Lizenzmail, Passwort dein Lizenzschlüssel.

{
    "http-basic": {
        "www.gratorder.de": {
            "username": "deine-email@example.com",
            "password": "GO-XXXX-XXXX-XXXX-XXXX"
        }
    }
}

Die auth.json enthält deinen Lizenzschlüssel. Leg sie nie in den Ordner public und gib sie nicht weiter.

3. Installieren

Mit dem Contao Manager: Öffne den Manager, klicke unter „Pakete“ auf „Pakete aktualisieren“ und bestätige die Änderungen. Danach bietet der Manager an, die Datenbank zu aktualisieren. Das bestätigst du ebenfalls.

GratOrder in der Paketübersicht des Contao Managers

Mit Composer auf der Kommandozeile:

composer update gratlinie/contao-gratorder --with-dependencies
vendor/bin/contao-console contao:migrate

Beim ersten Aktualisieren der Datenbank legt GratOrder die Benutzergruppen „GratOrder“ und „GratOrder-Terminal“ und die drei Bestellmails im Notification Center an.

4. Cronjob einrichten

GratOrder lehnt überfällige Bestellungen automatisch ab und wiederholt fehlgeschlagene Bons. Dafür muss der Contao-Cron jede Minute laufen. Lege beim Hoster einen Cronjob an, der jede Minute diese Adresse aufruft:

https://deine-domain.de/_contao/cron

Ob der Cron läuft, siehst du später im Backend unter GratOrder → Konfiguration → Status.

Status des Contao-Crons in der GratOrder-Konfiguration

5. Shop einrichten

  1. Konfiguration: Name, Logo, Telefon und E-Mail des Restaurants, Bestellarten mit Mindestbestellwert für Lieferung, Zahlungsarten (bar, online über SumUp oder beides), Öffnungszeiten, Steuersätze und Design. Unter „Lizenz“ trägst du den Lizenzschlüssel aus der Lizenzmail ein; ohne Schlüssel läuft GratOrder 14 Tage zur Einrichtung.
    GratOrder-Konfiguration im Backend
  2. Speisekarte: Größen, Allergene und Zusatzstoffe, Optionsgruppen (z. B. Beläge), dann Kategorien und Produkte.
    Produkte einer Kategorie im Backend
  3. Seiten: Lege die Frontend-Module „Bestellshop“, „Checkout“ und „Bestellbestätigung“ an und binde sie auf je einer Seite ein. Checkout und Bestätigung blendest du in der Navigation aus.
  4. Benutzer: Das Restaurant bekommt einen Benutzer in der Gruppe „GratOrder“, das Tablet einen eigenen Benutzer in der Gruppe „GratOrder-Terminal“. Das Tablet landet nach dem Login direkt im Bestellterminal.
    Bestellterminal mit neuen, laufenden und fertigen Bestellungen
  5. Bestellmails: Prüfe im Notification Center Absender und Texte der drei GratOrder-Mails.
  6. Bondrucker (optional): Netzwerkdrucker direkt oder über die Druck-Brücke im Restaurant; die Anleitung steht in der Konfiguration.
  7. Online-Zahlung (optional): Im SumUp-Dashboard unter Einstellungen → Für Entwickler einen API-Key anlegen und ihn mit deinem Merchant Code in der Konfiguration unter „Bezahlung“ eintragen. Für Apple Pay schaltet SumUp dein Konto frei; du registrierst deine Domain unter „Payment wallets“ und legst die Datei von Apple in public/.well-known/ ab. Apple Pay erscheint dann in Safari.

Mach zum Schluss eine Testbestellung und nimm sie am Tablet an.

6. Updates

Neue Versionen installierst du wie oben über „Pakete aktualisieren“ bzw. composer update. Solange dein Abo läuft, bekommst du alle neuen Versionen. Im Backend zeigt GratOrder unter Konfiguration → Lizenz an, wenn eine neue Version verfügbar ist, mit Link auf die Änderungen.

Update-Service: Hast du ihn gebucht, spielen wir neue Versionen für dich ein und prüfen danach den Shop. Leg dafür im Contao Manager unter „Benutzer“ einen eigenen Zugang für uns an. Wie wir die Zugangsdaten sicher austauschen, stimmen wir nach der Buchung mit dir ab.

7. Wenn etwas nicht klappt

  • Anmeldung abgelehnt (401): Benutzername muss genau die E-Mail-Adresse aus der Lizenzmail sein, Passwort der Lizenzschlüssel mit Bindestrichen. Ist dein Abo beendet, wird die Anmeldung ebenfalls abgelehnt. Der Eintrag in der auth.json heißt www.gratorder.de, mit „www“.
  • Version nicht enthalten (403): Betrifft nur Lizenzen aus dem früheren Einmalkauf: Die Version ist nach dem Ende deines Update-Zeitraums erschienen.
  • Paket nicht gefunden: Prüfe den Eintrag unter repositories in der composer.json.
  • „Online-Bestellungen sind derzeit nicht möglich“: Prüfe unter GratOrder → Konfiguration → Lizenz, ob dein Lizenzschlüssel eingetragen und gültig ist.

Du kommst nicht weiter? Schreib uns an mail@gratlinie.de.