Einrichtung

Sobald die Makaira-Applikation bereit steht, kann das OXID Connect-Modul, welches die Makaira an Deinen Shop anbindet, installiert werden.

Installation des Connect-Moduls

Das Connect Modul kann ganz einfach via composer installiert werden. Sollten Sie das Connect-Modul als Paket benötigen wenden Sie sich bitte an unseren Support.

Hinweis: Für OXID Versionen vor 6.2 wird zusätzlich ein Kompatibilitäts-Modul benötigt.

Versionen vor OXID 6.0

Füge das OXID-Connect- und OXID-Connect-Compat-Modul in Deine composer.json ein und passe <SHOP-ROOT> entsprechend Deines Setups an (für OXID 6.x ist <SHOP-ROOT> durch source zu ersetzen).

{
  "require": {
    "makaira/oxid-connect": "^2.0",
    "makaira/oxid-connect-compat": "^2.0"
  },
  "scripts": {
    "pre-install-cmd": ["mkdir -p <SHOP-ROOT>/modules/makaira/", "touch <SHOP-ROOT>/modules/makaira/vendormetadata.php"],
    "pre-update-cmd": ["mkdir -p <SHOP-ROOT>/modules/makaira/", "touch <SHOP-ROOT>/modules/makaira/vendormetadata.php"]
  },
  "extra": {
    "installer-paths": {
      "<SHOP-ROOT>/modules/makaira/connect": ["makaira/oxid-connect"]
    }
  }
}

Nach der Anpassung muss noch composer update ausgeführt werden. Nach dem Abschluss kann das Modul kann nun im Shop aktiviert werden.

Für OXID Versionen vor 6.0 ist es ggf. noch erforderlich die vendor/autoload.php mittels include einzubinden.
Hinweis: Das vendor-Verzeichnis befindet sich auf der gleichen Verzeichnis-Ebene wie die composer.json.

Folge dann den Next Steps am Ende dieser Seite.

OXID 6.0 und 6.1 Versionen

Die Installation ist der von vor OXID 6.0 sehr ähnlich. Jedoch wird der scripts-Teil nicht mehr benötigt, da die vendormetadata.php ab OXID 6.0 ignoriert wird. Das Kompatibilitäts-Modul ist weiterhin erforderlich.
Daraus ergibt sich für die composer.json folgende Konfiguration:

{
  "require": {
    "makaira/oxid-connect": "^2.0",
    "makaira/oxid-connect-compat": "^2.0"
  },
  "extra": {
    "installer-paths": {
      "<SHOP-ROOT>/modules/makaira/connect": ["makaira/oxid-connect"]
    }
  }
}

Nach der Anpassung muss noch composer update ausgeführt werden. Nach dem Abschluss kann das Modul kann nun im Shop aktiviert werden.

Folge dann den Next Steps am Ende dieser Seite.

Ab OXID 6.2

Mit OXID 6.2 entfällt das Kompatibilitäts-Modul und das Connect-Modul kann direkt verwendet werden.

{
  "require": {
    "makaira/oxid-connect": "^2.0"
  },
  "extra": {
    "installer-paths": {
      "<SHOP-ROOT>/modules/makaira/connect": ["makaira/oxid-connect"]
    }
  }
}

Nach der Anpassung muss noch composer update ausgeführt werden. Nach dem Abschluss kann das Modul kann nun im Shop aktiviert werden.

Folge dann den Next Steps am Ende dieser Seite.

Next Steps nach Deployment

Konfiguration des Connect Moduls

Für die Konfiguration des Connect-Moduls können alle relevanten Informationen (Makaira Secret, Makaira Instanz und Makaira-URL) unter der Route <SUBDOMAIN>.makaira.io/#/install bzw. über das "Profilbild" -> "Installation" gefunden werden.

Tragen Diese Daten - evtl. für jeden Subshop getrennt - in die Modul-Konfiguration des Connect Moduls im OXID ein.

Ersten Daten-Import vorbereiten

Anschließend ist es erforderlich die Daten für den initialen Import in Makaira zu markieren. Wir nennen diesen Vorgang "Touch aller Dokumente" - Hierfür stellt das Connect-Modul ein entsprechendes Konsolen-Kommando bereit:

php vendor/bin/makaira-console makaira:touch-all

Abschließend kann in Absprache mit dem Makaira-Support der erste Import für die Daten in Makaira erfolgen.