Installation

Note

Watch a short video tutorial on YouTube: Module Installation & Configuration.

This section describes module installation process in OXID eShop.

Installing module

There are 2 ways of installing a module:

  1. Composer installation

  2. Manual installation

@startuml start if (How?) then (Manual installation) :Execute installation command; :Register module in \nproject composer.json; :Execute registered module \ncomposer installation; else (Composer installation) :Execute composer installation; endif :Module installed; stop @enduml

Composer installation

Module can be installed with regular composer installation. Composer performs all necessary installation steps.

Sample command how to install the OXID eShop Module Template module with composer:

composer require oxid-esales/module-template

Manual installation

Manual installation is another way of installing a module, which usually is used for module development. The steps can be found in document: best practice module setup for development.