Wie kommen die Dateien aus Individualmodulen in den Shop?

  Anleitungen, OXID V6, Composer, Installation

Im Regelfall stellen wir dem Kunden an seinem Konto bei git.d3data.de das Repository zur Installation zur Verfügung. Bedingung ist, dass sich der Kunde dort ein Konto anlegt. D3-Administratoren können private Repositories dann dem Kundenkonto (ggf. mit eingeschränkten Rechten) verfügbar machen. Um das Modul in der Kundeninstallation via Composer zu installieren, gibt es folgende Wege, die absteigend von sicher zu unsicher sortiert sind:

Option 1: Checkout mit SSH Keys (empfohlen)

  • ist sehr sicher, da nie anmeldefähige Zugangsdaten übermittelt werden
  • ist etwas intensiver in der Einrichtung, da zum Zeitpunkt des Checkouts der private Key am Zielsystem verfügbar sein muss. KeyAgent und Key können beim Öffnen der Shell automatisch gestartet werden (.profile), dann fällt diese Einrichtung nur einmal an.
  • Composer verwendet die git-Informationen zur Versionierung und zum Updatecheck.

Zur Einrichtung können am git.d3data.de-Kundenkonto die öffentlichen Schlüssel hinterlegt werden. Dort ist auch einstellbar, ob der Key Schreibzugriff auf das Repo haben darf.

Am Server ist der KeyAgent zu starten und der private Schlüssel zu laden oder in der .profile zu konfigurieren.
Als Checkout-URL wird die SSH-Adresse des Repositories verwendet. Die Angabe des Konto-Benutzernamens und des Konto-Passworts erfolgt nie.

Option 2: Checkout mit AccessToken (nur bedingt empfohlen)

  • ist nicht sicher, da der Token Vollzugriff auf das gesamte git.d3data.de-Konto hat
  • beim Checkout wird die Kombination Benutzername + Passwort übermittelt, landet ggf. auch in der History
  • Composer verwendet die git-Informationen zur Versionierung und zum Updatecheck.

Zur Einrichtung können am git.d3data.de-Kundenkonto die benötigten Token angelegt werden.

Rechteeinschränkungen sind dort aber nicht möglich. Als Checkout-URL wird die um Benutzernamen und Token ergänzte HTTPS-Adresse des Repositories verwendet:

https://[Username]:[PasswortOderToken]@git.d3data.de/[Ordner]/[Repository].git

Option 3: als ZIP bereitstellen (nicht empfohlen)

  • Das Paket muss ausdrücklich mit einer Versionsnummer in den Dateien vorbereitet sein.
  • Composer kann nötige Updates nicht selbst erkennen. Auch dann nicht, wenn die ZIP-Datei aktualisiert wurde.
  • erfordert damit immer eine manuellen Aufwand durch das Hochladen der Quelle (ZIP-Datei) und das Konfiguieren des „Zwangsupdates“.

Option 4: in vendor- oder source-Ordner kopieren oder dorthin auschecken (dringend abzuraten)

  • hat alle Nachteile von Option 3 und zusätzlich
  • die Gefahr des ungewollten Überschreibens von Dateien, da Composer über die Ordner die alleinige Hoheit hat und entsprechend agiert