Mit Composer installieren

Jedes lizenzierte UnleashWP-Plugin und Theme gibt es auch als Composer-Paket. Wenn du deine Websites mit Composer baust und auslieferst, holst du unsere Produkte genauso wie alles andere. Als Zugang brauchst du dabei nur deinen Lizenzschlüssel.

Was Composer ist

Composer ist der Paketmanager für PHP. Du trägst in eine Datei namens composer.json ein, welche Plugins und Themes eine Website braucht, führst einen Befehl aus, und Composer lädt genau diese Versionen in die richtigen Ordner. Dazu schreibt es eine composer.lock, die jede Version festhält. So landet auf deinem Rechner, auf Staging und auf der Live-Seite derselbe Code.

Bevor du loslegst

• Composer 2 auf deinem Rechner oder Build-Server (composer --version).
• Ein WordPress-Projekt mit einer composer.json, zum Beispiel ein Bedrock-Projekt oder dein eigenes Setup.
• Eine aktive UnleashWP-Lizenz. Du findest sie in deinem Konto unter Lizenzen.

Schnellstart

Schritt für Schritt

1. Composer deinen Lizenzschlüssel geben

Dein Lizenzschlüssel ist das Passwort. Der Benutzername wird nicht geprüft, im Konto steht unleashwp. Such dir einen Weg aus:

composer config --global --auth http-basic.composer.unleash-wp.com unleashwp DEIN_LIZENZSCHLUESSEL

{
  "http-basic": {
    "composer.unleash-wp.com": {
      "username": "unleashwp",
      "password": "DEIN_LIZENZSCHLUESSEL"
    }
  }
}

echo "auth.json" >> .gitignore

2. Repository und Paket eintragen

Trag unser Repository und das Paket in die composer.json deines Projekts ein:

{
  "repositories": [
    { "type": "composer", "url": "https://composer.unleash-wp.com" }
  ],
  "require": {
    "unleashwp/easy-svg-pro": "^1.0"
  },
  "config": {
    "allow-plugins": {
      "composer/installers": true
    }
  }
}

• Jedes Paket heißt unleashwp/ plus der Slug des Produkts, zum Beispiel unleashwp/easy-svg-pro. Der Dialog in deinem Konto zeigt dir den genauen Namen und eine passende Versionsangabe für das aktuelle Release.
• Unsere Pakete brauchen composer/installers, das Plugins und Themes in die WordPress-Ordner verschiebt. Ab Composer 2.2 fragt Composer nach, bevor es so ein Plugin ausführt. Der Eintrag allow-plugins beantwortet die Frage vorab. Das ist vor allem auf einem Build-Server wichtig, wo niemand "ja" tippen kann.

Dann installieren:

composer update unleashwp/easy-svg-pro

3. Wo die Dateien landen

composer/installers richtet sich nach dem Pakettyp:

Liegt dein WordPress woanders, setzt du installer-paths. In einem Bedrock-Projekt ist das schon erledigt:

{
  "extra": {
    "installer-paths": {
      "web/app/plugins/{$name}/": ["type:wordpress-plugin"],
      "web/app/themes/{$name}/": ["type:wordpress-theme"]
    }
  }
}

4. Lizenz über die wp-config.php aktivieren

Composer bringt nur die Dateien. Aktiviert wird die Lizenz über eine Konstante in der wp-config.php. Lies den Schlüssel aus der Server-Umgebung, dann steht er auch nicht in Git:

define( 'EASY_SVG_PRO_LICENSE_KEY', getenv( 'EASY_SVG_PRO_LICENSE_KEY' ) );

Danach setzt du EASY_SVG_PRO_LICENSE_KEY auf dem Server, im Hosting-Panel, in deiner .env oder in deinem Deployment-Tool. Sobald ein Administrator das nächste Mal wp-admin öffnet, aktiviert sich die Website selbst und belegt einen Platz deiner Lizenz. Mehr dazu unter Lizenzschlüssel aktivieren und Mit Git und CI ausliefern.

Aktualisieren

composer update unleashwp/easy-svg-pro

Das holt die neueste Version, die deine Versionsangabe erlaubt, und schreibt sie in die composer.lock. Committe die composer.lock. Jedes spätere composer install installiert dann auf jedem Rechner genau diese Version, und Staging und Live bleiben gleich.

Mit aktiver Lizenz bietet dir auch WordPress Updates unter Dashboard → Aktualisierungen an. Auf einer Composer-Website soll meist nur Composer aktualisieren, damit die Dateien auf dem Server immer zur composer.lock passen. Updates aus wp-admin schaltest du so ab:

define( 'DISALLOW_FILE_MODS', true );

In CI nutzen

Auf einem Build-Server gibst du Composer den Schlüssel über die Umgebungsvariable COMPOSER_AUTH statt über eine Datei. Leg den Schlüssel als Secret in deinem CI-System ab, nie im Repository.

- name: Install PHP dependencies
  env:
    COMPOSER_AUTH: '{"http-basic":{"composer.unleash-wp.com":{"username":"unleashwp","password":"${{ secrets.UNLEASHWP_LICENSE_KEY }}"}}}'
  run: composer install --no-dev --no-interaction --prefer-dist

export COMPOSER_AUTH='{"http-basic":{"composer.unleash-wp.com":{"username":"unleashwp","password":"DEIN_LIZENZSCHLUESSEL"}}}'
composer install --no-dev --no-interaction --prefer-dist

Eine Lizenz pro Projekt

Composer kann pro Host nur ein Passwort speichern. Weil dein Lizenzschlüssel dieses Passwort ist, nutzt ein Projekt einen Lizenzschlüssel für alles, was es von composer.unleash-wp.com installiert.

• Der Schlüssel zeigt nur die Produkte, die zu dieser Lizenz gehören. Zwei Produkte aus zwei getrennten Lizenzen lassen sich nicht im selben Projekt mit einem Schlüssel über Composer installieren.
• Die Installation mit Composer belegt keinen Platz. Einen Platz belegt erst die Website, die sich über die Konstante in der wp-config.php aktiviert, siehe Lizenzen.
• Für Agenturen: Nimm für jedes Kundenprojekt die Lizenz, die du für diesen Kunden gekauft hast. Dann steckt in jedem Projekt nur sein eigener Schlüssel.

Wenn es nicht klappt

Sicherheit

• Dein Schlüssel reist nur im Request-Header an composer.unleash-wp.com, nie in einer URL.
• Halt die auth.json aus Git heraus. Am besten nutzt du auf deinem Rechner den globalen Befehl und auf Build-Servern COMPOSER_AUTH.
• Schreib den Schlüssel nicht in composer.json, composer.lock, Dockerfiles oder Build-Logs.
• Ist ein Schlüssel nach außen gelangt, melde dich sofort beim Support.