From 1af93d170de286d930e79d93e0b0b22cf4c5ca5e Mon Sep 17 00:00:00 2001 From: Daniel Seifert Date: Tue, 20 Jul 2021 10:20:49 +0200 Subject: [PATCH] Squashed 'docs/daux/' changes from 2969156..4b531cd 4b531cd Merge branch 'dev_daux-templates_CLI' into daux-templates 0c625cd add CLI commands 7a60a9d fix typo b8bae35 rename template filenames to prevent broken links f0f2531 update patch instructions f94009e fix typo a9a1ff1 php version note added b267e64 move all patch informations to separate chapters 767ff35 Merge branch 'daux-templates' of git.d3data.de:D3Private/vorlagen into daux-templates f6471ee fix special chars behaviour 1a0e40e Vorbereitung Patch Doku 4d2672f remove patch package, because it's listet in modules composer.json a414a21 Merge branch 'daux-templates' of git.d3data.de:D3Private/vorlagen into daux-templates 3b7beae adjust patching instructions git-subtree-dir: docs/daux git-subtree-split: 4b531cd1204c8efc327aa468503cb5339b1ef4f4 --- config.json | 1 + .../010_Systemanforderungen.md | 11 ++++++--- ...030_Kompatibilitaet_mit_anderen_Modulen.md | 2 +- .../010_Patch_hinzufuegen.md | 23 +++++++++++++++++++ .../020_Modul_hinzufuegen.md | 10 +++----- .../030_Verwendung_eigener_Themes.md | 1 + .../050_Modul_im_Shop_aktivieren.md | 14 ++++++++++- .../060_Shopanpassungen_installieren.md | 12 +++++++++- .../070_TMP-Ordner_leeren.md | 14 ++++++++++- .../080_Lizenz_eintragen.md | 2 ++ installation/020_Neuinstallation/_index.md | 5 ++++ .../030_Update/005_Updatedefinition.md | 2 +- .../030_Update/010_Modul_deaktivieren.md | 16 ++++++++++++- .../030_Update/015_Patch_hinzufuegen.md | 23 +++++++++++++++++++ .../030_Update/020_Dateien_erneuern.md | 10 ++------ .../040_Modulinformationen_aktualisieren.md | 16 ++++++++++++- .../050_Shopanpassungen_installieren.md | 12 +++++++++- .../030_Update/060_TMP-Ordner_leeren.md | 14 ++++++++++- .../070_Lizenzschluessel_aktualisieren.md | 2 ++ .../020_Modul_deaktivieren.md | 15 +++++++++++- ...30_Modul_aus_der_Installation_entfernen.md | 6 ++--- .../040_Dateien_loeschen.md | 2 +- .../060_TMP-Ordner_leeren.md | 14 ++++++++++- 23 files changed, 194 insertions(+), 33 deletions(-) create mode 100644 installation/020_Neuinstallation/010_Patch_hinzufuegen.md create mode 100644 installation/030_Update/015_Patch_hinzufuegen.md diff --git a/config.json b/config.json index 3dfe754..b5c5118 100644 --- a/config.json +++ b/config.json @@ -65,6 +65,7 @@ "modulename" : " MODULNAME", "menutitle" : " MODULNAME", "modulefolder" : "module_folder", + "metadataident" : "d3moduleid", "modcfgident" : "d3modident", "composerident" : "d3/moduleident" }, diff --git a/installation/010_Anforderungen/010_Systemanforderungen.md b/installation/010_Anforderungen/010_Systemanforderungen.md index b379d87..72bbea3 100644 --- a/installation/010_Anforderungen/010_Systemanforderungen.md +++ b/installation/010_Anforderungen/010_Systemanforderungen.md @@ -6,8 +6,13 @@ title: Systemanforderungen * 5.6.x bis 7.4.x * PHP Decoder * installierter ionCube Loader -* Shopversionen / -editionen - * OXID eShop Community Edition (CE), Professional Edition (PE) oder Enterprise Edition (EE) in Compilation Version +* Shopeditionen + * OXID eShop Community Edition (CE) + * OXID eShop Professional Edition (PE) + * OXID eShop Enterprise Edition (EE) + * OXID eShop B2B Edition +* Shopversionen + * OXID eShop in Compilation Version * 6.0.x * 6.1.x * 6.2.x @@ -18,6 +23,6 @@ title: Systemanforderungen * Installation via [Composer](https://getcomposer.org) * mindestens ein freier Cronjob zur automatischen Ausführung der angelegten Aufgaben -Beachten Sie, dass die Ihnen vorliegende Modulversion entsprechend für **PHP 5.6**, **PHP 7.0**, **PHP 7.1**, **PHP 7.2**, **PHP 7.3** oder **PHP 7.4** sowie dem auf Ihrem Server vorhandenen Decoder (**ionCube Loader**) kompatibel ist. Im Zweifelsfall kontaktieren Sie uns und nennen den für Ihren Shop genutzten Decoder und die PHP-Version. +Beachten Sie, dass die Ihnen vorliegende Modulversion entsprechend für Ihre genutzte PHP-Version sowie dem auf Ihrem Server vorhandenen Decoder (**ionCube Loader**) kompatibel ist. Im Zweifelsfall kontaktieren Sie uns und nennen den für Ihren Shop genutzten Decoder und die PHP-Version. Kontrollieren Sie bitte auch, ob diese Modulversion für die von Ihnen eingesetzte Shopedition (Professional Edition (PE) oder Enterprise Edition (EE)) ausgelegt ist. diff --git a/installation/010_Anforderungen/030_Kompatibilitaet_mit_anderen_Modulen.md b/installation/010_Anforderungen/030_Kompatibilitaet_mit_anderen_Modulen.md index 5f91b53..e8a4fce 100644 --- a/installation/010_Anforderungen/030_Kompatibilitaet_mit_anderen_Modulen.md +++ b/installation/010_Anforderungen/030_Kompatibilitaet_mit_anderen_Modulen.md @@ -2,4 +2,4 @@ title: Kompatibilität mit anderen Modulen --- -Das „Modul“ integriert sich auch in die Erweiterung „Visual CMS“ von OXID eSales AG & digidesk - media solutions, sofern diese im Shop installiert wurde. Diese Integration wurde für die Version 3.0.0 des „Visual CMS“-Moduls entwickelt. \ No newline at end of file +Das Modul **{$modulename}** integriert sich auch in die Erweiterung "Visual CMS" von OXID eSales AG & digidesk - media solutions, sofern diese im Shop installiert wurde. Diese Integration wurde für die Version 3.0.0 des "Visual CMS"-Moduls entwickelt. \ No newline at end of file diff --git a/installation/020_Neuinstallation/010_Patch_hinzufuegen.md b/installation/020_Neuinstallation/010_Patch_hinzufuegen.md new file mode 100644 index 0000000..f56a2f9 --- /dev/null +++ b/installation/020_Neuinstallation/010_Patch_hinzufuegen.md @@ -0,0 +1,23 @@ +--- +title: Patch zur Installation hinzufügen +--- + +### **auf der Kommandozeile** + +Für das Modul **{$modulename}** sind Anpassungen an den originalen Dateien des Shops nötig. Die Änderungen werden automatisiert als Patches eingespielt. Um diese Patches integrieren zu können, ist es nötig, in der `composer.json`-Datei des Shopprojektes das Anwenden der Patches zu erlauben. + +Führen Sie in der Konsole im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) diesen Befehl aus: + +```bash +php composer config extra.enable-patching true +``` + +> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#config). + +Im weiteren Ablauf der Installation werden Sie gefragt, ob die Dateien der folgenden Pakete überschrieben werden sollen: + +* oxid-esales/... + +Bestätigen Sie diese Frage, um den mitgelieferten Patch anzuwenden. + +> [i] Beachten Sie, dass darin durchgeführte manuelle Änderungen überschrieben werden. \ No newline at end of file diff --git a/installation/020_Neuinstallation/020_Modul_hinzufuegen.md b/installation/020_Neuinstallation/020_Modul_hinzufuegen.md index 9092ac0..a239c1a 100644 --- a/installation/020_Neuinstallation/020_Modul_hinzufuegen.md +++ b/installation/020_Neuinstallation/020_Modul_hinzufuegen.md @@ -2,13 +2,7 @@ title: Modul zur Installation hinzufügen --- -Für das Modul **{$modulename}** sind Anpassungen an den originalen Dateien des Shops nötig. Die Änderungen werden automatisiert als Patches eingespielt. Um diese Patches integrieren zu können, ist es nötig, in der `composer.json`-Datei des Shopprojektes das Anwenden der Patches zu erlauben. - -Führen Sie dann in der Konsole im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) diesen Befehl aus: - -```bash -php composer config extra.enable-patching true -``` +### **auf der Kommandozeile** Führen Sie in der Konsole im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) diesen Befehl aus, um das Modul **{$modulename}** zur Installation hinzuzufügen: @@ -16,4 +10,6 @@ Führen Sie in der Konsole im Hauptverzeichnis Ihres Shops (oberhalb des `source php composer require {$composerident}:^{$moduleversion} --update-no-dev ``` +> [!] Achten Sie darauf, dass Composer für die Installation die selbe PHP-Version verwendet, in der auch Ihr Shop ausgeführt wird. Sie erhalten sonst möglicherweise unpassende Modulpakete. + > [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require). diff --git a/installation/020_Neuinstallation/030_Verwendung_eigener_Themes.md b/installation/020_Neuinstallation/030_Verwendung_eigener_Themes.md index 0123a15..b7e74d0 100644 --- a/installation/020_Neuinstallation/030_Verwendung_eigener_Themes.md +++ b/installation/020_Neuinstallation/030_Verwendung_eigener_Themes.md @@ -4,6 +4,7 @@ title: Verwendung eigener Themes Das Modul ist für die Verwendung mit den folgenden OXID-Themes vorbereitet: +* Wave * Flow * Azure diff --git a/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md b/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md index 02ea797..75c2f3e 100644 --- a/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md +++ b/installation/020_Neuinstallation/050_Modul_im_Shop_aktivieren.md @@ -2,6 +2,18 @@ title: Modul im Shop aktivieren --- +### **im Adminbereich** + Aktivieren Sie das Modul über den Shopadmin unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ]. -> [!] **Enterprise Editon**: Achten Sie darauf, dass das Modul in weiteren Shops (Mall) ebenfalls aktiviert werden muss, um dessen Funktion dort auch zu nutzen. \ No newline at end of file +### **oder auf der Kommandozeile** + +Alternativ können Sie die Modulaktivierung auch auf der Kommandozeile (CLI) im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) durchführen. + +```bash +./vendor/bin/oe-console oe:module:activate {$metadataident} +``` + +> [!] **Enterprise Edition**: Achten Sie darauf, dass das Modul in weiteren Shops (Mall) ebenfalls aktiviert werden muss, um dessen Funktion dort auch zu nutzen. + +> [i] **Enterprise Edition**: Zur Aktivierung in einem bestimmten Shopmandanten verwenden Sie das `--shop-id`-Argument (`...oe-console --shop-id 1 oe:module...`) \ No newline at end of file diff --git a/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md b/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md index 636441d..6f55278 100644 --- a/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md +++ b/installation/020_Neuinstallation/060_Shopanpassungen_installieren.md @@ -2,10 +2,20 @@ title: Shopanpassungen installieren --- +### **im Adminbereich** + Direkt nach der Modulaktivierung startet der Assistent, der Sie durch die Shopanpassung führt. Darin können Sie verschiedene Optionen der Installation wählen. Den Installationsassistenten finden Sie auch unter den Menüpunkten [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ]. Bei tiefgreifenden Änderungen an Ihrem Shop (z.B. Hinzufügen weiterer Sprachen oder Mandanten) rufen Sie den Installationsassistenten bitte erneut auf, um dann eventuell notwendige Nacharbeiten für das Modul ausführen zu lassen. -Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen. \ No newline at end of file +Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen. + +### **oder auf der Kommandozeile** + +Der Installationsassistent steht Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3modules_install +``` \ No newline at end of file diff --git a/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md b/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md index fb6a3a2..d845b9b 100644 --- a/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md +++ b/installation/020_Neuinstallation/070_TMP-Ordner_leeren.md @@ -2,8 +2,20 @@ title: TMP-Ordner leeren --- +### **im Adminbereich** + Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ]. Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch. -> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. \ No newline at end of file +### **oder auf der Kommandozeile** + +Alle TMP-leeren-Aktionen stehen Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3cleartmp +``` + +> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. + +> [i] Beim Kommandozeilenaufruf werden Ihnen weitere Optionen gezeigt, mit denen Sie die Aktion gezielt steuern können. \ No newline at end of file diff --git a/installation/020_Neuinstallation/080_Lizenz_eintragen.md b/installation/020_Neuinstallation/080_Lizenz_eintragen.md index 1e75d27..c53de98 100644 --- a/installation/020_Neuinstallation/080_Lizenz_eintragen.md +++ b/installation/020_Neuinstallation/080_Lizenz_eintragen.md @@ -2,6 +2,8 @@ title: Lizenzschlüssel eintragen --- +### **im Adminbereich** + Das Modul verwendet Lizenzschlüssel, um die Lizenzverwaltung für Sie und auch für uns einfacher zu gestalten. Hierbei haben Sie je nach Modul die Wahl zwischen einer kostenfreien Testlizenz und einer Lizenz für den Einsatz im Livebetrieb. Speziell **{$modulename}** wird in unterschiedlichen (teilweise kostenfreien) Editionen für den Livebetrieb angeboten. Besuchen Sie unseren [Moduleshop](https://www.oxidmodule.com/), um mehr darüber zu erfahren. diff --git a/installation/020_Neuinstallation/_index.md b/installation/020_Neuinstallation/_index.md index 3c7760a..ea7dc79 100644 --- a/installation/020_Neuinstallation/_index.md +++ b/installation/020_Neuinstallation/_index.md @@ -4,8 +4,13 @@ Title: Schnellstart per Composer ## Schnellstart per Composer +### **auf der Kommandozeile** + ```bash php composer require {$composerident}:^{$moduleversion} --update-no-dev +./vendor/bin/oe-console oe:module:activate {$metadataident} +./vendor/bin/d3modules_install +./vendor/bin/d3cleartmp ``` Detailliertere Angaben zur Installation entnehmen Sie bitte den folgenden Seiten. diff --git a/installation/030_Update/005_Updatedefinition.md b/installation/030_Update/005_Updatedefinition.md index 492cee3..3e3e9f3 100644 --- a/installation/030_Update/005_Updatedefinition.md +++ b/installation/030_Update/005_Updatedefinition.md @@ -2,7 +2,7 @@ title: Wann kann ein Update ausgeführt werden? --- -Die Updatenaweisungen können verwendet werden, wenn dieses Modul schon früher mit Hilfe von Composer installiert wurde. +Die Updateanweisungen können verwendet werden, wenn dieses Modul schon früher mit Hilfe von Composer installiert wurde. Wurde die Installation bisher noch nicht durchgeführt oder die Installation wurde **nicht** über Composer durchgeführt (weil das Modul dies z.B. früher nicht unterstützte), verwenden Sie bitte die Beschreibung unter [Neuinstallation](../020_Neuinstallation/_index.md). \ No newline at end of file diff --git a/installation/030_Update/010_Modul_deaktivieren.md b/installation/030_Update/010_Modul_deaktivieren.md index ba3f82d..4ba4d78 100644 --- a/installation/030_Update/010_Modul_deaktivieren.md +++ b/installation/030_Update/010_Modul_deaktivieren.md @@ -2,4 +2,18 @@ title: Modul deaktivieren --- -Deaktivieren Sie das Modul über den Shopadmin unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ]. \ No newline at end of file +### **im Adminbereich** + +Deaktivieren Sie das Modul unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ]. + +### **oder auf der Kommandozeile** + +Alternativ können Sie die Moduldeaktivierung auch über die Kommandozeile (CLI) im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) durchführen. + +```bash +./vendor/bin/oe-console oe:module:deactivate {$metadataident} +``` + +> [!] **Enterprise Edition**: Achten Sie darauf, dass das Modul in allen weiteren Shops (Mall) ebenfalls deaktiviert werden muss. + +> [i] **Enterprise Edition**: Zur Deaktivierung in einem bestimmten Shopmandanten verwenden Sie das `--shop-id`-Argument (`...oe-console --shop-id 1 oe:module...`) \ No newline at end of file diff --git a/installation/030_Update/015_Patch_hinzufuegen.md b/installation/030_Update/015_Patch_hinzufuegen.md new file mode 100644 index 0000000..f56a2f9 --- /dev/null +++ b/installation/030_Update/015_Patch_hinzufuegen.md @@ -0,0 +1,23 @@ +--- +title: Patch zur Installation hinzufügen +--- + +### **auf der Kommandozeile** + +Für das Modul **{$modulename}** sind Anpassungen an den originalen Dateien des Shops nötig. Die Änderungen werden automatisiert als Patches eingespielt. Um diese Patches integrieren zu können, ist es nötig, in der `composer.json`-Datei des Shopprojektes das Anwenden der Patches zu erlauben. + +Führen Sie in der Konsole im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) diesen Befehl aus: + +```bash +php composer config extra.enable-patching true +``` + +> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#config). + +Im weiteren Ablauf der Installation werden Sie gefragt, ob die Dateien der folgenden Pakete überschrieben werden sollen: + +* oxid-esales/... + +Bestätigen Sie diese Frage, um den mitgelieferten Patch anzuwenden. + +> [i] Beachten Sie, dass darin durchgeführte manuelle Änderungen überschrieben werden. \ No newline at end of file diff --git a/installation/030_Update/020_Dateien_erneuern.md b/installation/030_Update/020_Dateien_erneuern.md index 56007de..15504c3 100644 --- a/installation/030_Update/020_Dateien_erneuern.md +++ b/installation/030_Update/020_Dateien_erneuern.md @@ -2,13 +2,7 @@ title: Dateien erneuern --- -Für das Modul **{$modulename}** sind Anpassungen an den originalen Dateien des Shops nötig. Die Änderungen werden automatisiert als Patches eingespielt. Um diese Patches integrieren zu können, ist es nötig, in der `composer.json`-Datei des Shopprojektes das Anwenden der Patches zu erlauben. - -Führen Sie dann in der Konsole im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) diesen Befehl aus: - -```bash -php composer config extra.enable-patching true -``` +### **auf der Kommandozeile** Starten Sie die Konsole Ihres Webservers und wechseln in das Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses). Führen Sie dort diesen Befehl aus: @@ -19,6 +13,6 @@ php composer require {$composerident}:^{$moduleversion} --update-no-dev Im weiteren Ablauf werden Sie gefragt, ob die Moduldateien überschrieben werden sollen. Bestätigen Sie dies für den Eintrag `{$composerident}`. -> [!] Achten Sie darauf, dass die Installation über Composer mit derselben PHP-Version erfolgt, in der auch Ihr Shop installiert ist. Sie erhalten sonst unpassende Modulpakete. +> [!] Achten Sie darauf, dass Composer für die Installation die selbe PHP-Version verwendet, in der auch Ihr Shop ausgeführt wird. Sie erhalten sonst möglicherweise unpassende Modulpakete. > [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require). \ No newline at end of file diff --git a/installation/030_Update/040_Modulinformationen_aktualisieren.md b/installation/030_Update/040_Modulinformationen_aktualisieren.md index 5e27899..157e8fa 100644 --- a/installation/030_Update/040_Modulinformationen_aktualisieren.md +++ b/installation/030_Update/040_Modulinformationen_aktualisieren.md @@ -2,4 +2,18 @@ title: Modulinformationen aktualisieren --- -Wechseln Sie im Adminbereich zu [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ]. \ No newline at end of file +### **im Adminbereich** + +Wechseln Sie im Adminbereich zu [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Aktivieren ]. + +### **oder auf der Kommandozeile** + +Alternativ können Sie die Modulaktivierung auch über die Kommandozeile (CLI) im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) durchführen. + +```bash +./vendor/bin/oe-console oe:module:activate {$metadataident} +``` + +> [!] **Enterprise Edition**: Achten Sie darauf, dass das Modul in weiteren Shops (Mall) ebenfalls aktiviert werden muss, um dessen Funktion dort auch zu nutzen. + +> [i] **Enterprise Edition**: Zur Aktivierung in einem bestimmten Shopmandanten verwenden Sie das `--shop-id`-Argument (`...oe-console --shop-id 1 oe:module...`) \ No newline at end of file diff --git a/installation/030_Update/050_Shopanpassungen_installieren.md b/installation/030_Update/050_Shopanpassungen_installieren.md index 577efa4..15880bb 100644 --- a/installation/030_Update/050_Shopanpassungen_installieren.md +++ b/installation/030_Update/050_Shopanpassungen_installieren.md @@ -2,10 +2,20 @@ title: Shopanpassungen installieren --- +### **im Adminbereich** + Ob Shopanpassungen notwendig sind, ist von der Versionsänderung des Moduls abhängig. Möglicherweise sehen Sie nach dem Neuaktivieren des Moduls den Installationsassistent, der Sie durch die Änderungen führt. Folgen Sie dann den einzelnen Schritten. Möchten Sie die Änderungen manuell installieren, können Sie sich über diesen Assistenten ebenfalls eine Checkliste erstellen. Wird der Assistent nicht gezeigt (Sie sehen wieder die Modulübersicht), waren keine Anpassungen am Shop notwendig. -Ob erforderliche Updates ausgeführt werden sollen, können Sie jederzeit im Adminbereich unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ] prüfen. \ No newline at end of file +Ob erforderliche Updates ausgeführt werden sollen, können Sie jederzeit im Adminbereich unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] -> [ Modulinstallation ] prüfen. + +### **oder auf der Kommandozeile** + +Der Installationsassistent steht Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3modules_install +``` \ No newline at end of file diff --git a/installation/030_Update/060_TMP-Ordner_leeren.md b/installation/030_Update/060_TMP-Ordner_leeren.md index fb6a3a2..d845b9b 100644 --- a/installation/030_Update/060_TMP-Ordner_leeren.md +++ b/installation/030_Update/060_TMP-Ordner_leeren.md @@ -2,8 +2,20 @@ title: TMP-Ordner leeren --- +### **im Adminbereich** + Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ]. Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch. -> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. \ No newline at end of file +### **oder auf der Kommandozeile** + +Alle TMP-leeren-Aktionen stehen Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3cleartmp +``` + +> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. + +> [i] Beim Kommandozeilenaufruf werden Ihnen weitere Optionen gezeigt, mit denen Sie die Aktion gezielt steuern können. \ No newline at end of file diff --git a/installation/030_Update/070_Lizenzschluessel_aktualisieren.md b/installation/030_Update/070_Lizenzschluessel_aktualisieren.md index 378a069..41bf6ae 100644 --- a/installation/030_Update/070_Lizenzschluessel_aktualisieren.md +++ b/installation/030_Update/070_Lizenzschluessel_aktualisieren.md @@ -2,4 +2,6 @@ title: Lizenzschlüssel aktualisieren --- +### **im Adminbereich** + Wird für die neue Modulversion ein aktualisierter Lizenzschlüssel benötigt, tragen Sie diesen im Adminbereich unter [ (D3) Module ] -> [ Modul-Connector ] -> [ Modulverwaltung ] ein. Klappen Sie dazu den Eintrag des jeweiligen Moduls aus und starten den Lizenzassistent. \ No newline at end of file diff --git a/installation/060_Deinstallation/020_Modul_deaktivieren.md b/installation/060_Deinstallation/020_Modul_deaktivieren.md index 067dc42..4ba4d78 100644 --- a/installation/060_Deinstallation/020_Modul_deaktivieren.md +++ b/installation/060_Deinstallation/020_Modul_deaktivieren.md @@ -2,5 +2,18 @@ title: Modul deaktivieren --- -Deaktivieren Sie das Modul **{$modulename}** über den Shopadmin [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ]. +### **im Adminbereich** +Deaktivieren Sie das Modul unter [ Erweiterungen ] -> [ Module ]. Klicken Sie nach Auswahl von [ {$menutitle} ] auf den Button [ Deaktivieren ]. + +### **oder auf der Kommandozeile** + +Alternativ können Sie die Moduldeaktivierung auch über die Kommandozeile (CLI) im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) durchführen. + +```bash +./vendor/bin/oe-console oe:module:deactivate {$metadataident} +``` + +> [!] **Enterprise Edition**: Achten Sie darauf, dass das Modul in allen weiteren Shops (Mall) ebenfalls deaktiviert werden muss. + +> [i] **Enterprise Edition**: Zur Deaktivierung in einem bestimmten Shopmandanten verwenden Sie das `--shop-id`-Argument (`...oe-console --shop-id 1 oe:module...`) \ No newline at end of file diff --git a/installation/060_Deinstallation/030_Modul_aus_der_Installation_entfernen.md b/installation/060_Deinstallation/030_Modul_aus_der_Installation_entfernen.md index 344eb78..02b3ebe 100644 --- a/installation/060_Deinstallation/030_Modul_aus_der_Installation_entfernen.md +++ b/installation/060_Deinstallation/030_Modul_aus_der_Installation_entfernen.md @@ -2,12 +2,12 @@ title: Modul aus der Installation entfernen --- +### **auf der Kommandozeile** + Starten Sie die Konsole Ihres Webservers und wechseln in das Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses). Führen Sie Sie dort diesen Befehl aus: ```Bash php composer remove {$composerident} --no-update ``` -> [!] Achten Sie darauf, dass die Installation über Composer mit derselben PHP-Version erfolgt, in der auch Ihr Shop installiert ist. Sie erhalten sonst unpassende Modulpakete. - -> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require). +> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#remove). \ No newline at end of file diff --git a/installation/060_Deinstallation/040_Dateien_loeschen.md b/installation/060_Deinstallation/040_Dateien_loeschen.md index 90c945d..5ce0b87 100644 --- a/installation/060_Deinstallation/040_Dateien_loeschen.md +++ b/installation/060_Deinstallation/040_Dateien_loeschen.md @@ -5,5 +5,5 @@ title: Dateien löschen Löschen Sie den Ordner `{$modulefolder}` und seine enthaltenen Elemente aus dem Verzeichnis `source/modules/d3` Ihres Shops. Bestätigen Sie anschließend im Shopadmin unter [ Erweiterungen ] -> [ Module ] -> [ Installierte Shop-Module ] die Nachricht: -> Es gibt registrierte Erweiterungen im eShop, deren Verzeichnis nicht vorhanden ist. +> Es gibt registrierte Erweiterungen im eShop, deren Verzeichnis nicht vorhanden ist. > Möchten Sie alle Modulinformationen einschließlich Konfigurationseinstellungen und Blockinformationen für Templates löschen? diff --git a/installation/060_Deinstallation/060_TMP-Ordner_leeren.md b/installation/060_Deinstallation/060_TMP-Ordner_leeren.md index fb6a3a2..d845b9b 100644 --- a/installation/060_Deinstallation/060_TMP-Ordner_leeren.md +++ b/installation/060_Deinstallation/060_TMP-Ordner_leeren.md @@ -2,8 +2,20 @@ title: TMP-Ordner leeren --- +### **im Adminbereich** + Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ]. Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch. -> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. \ No newline at end of file +### **oder auf der Kommandozeile** + +Alle TMP-leeren-Aktionen stehen Ihnen ebenfalls auf der Kommandozeile (CLI) zur Verfügung. Führen Sie diesen Befehl im Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses) aus: + +```bash +./vendor/bin/d3cleartmp +``` + +> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus. + +> [i] Beim Kommandozeilenaufruf werden Ihnen weitere Optionen gezeigt, mit denen Sie die Aktion gezielt steuern können. \ No newline at end of file