How to install a module on PrestaShop

 

Install a module from the administration panel

 

This is the easiest method, but it may not work in certain cases. If it does not work, use the manual installation method presented further below.

In the modules tab, click on add a new module.

If a file of the module exists online, specify its URL in the Module URL field and then click on Download this module.

If the file is on your computer, click on Browse to open the dialogue box letting you search your computer, select the file then validate the dialogue box. Finally click on Upload this module.

If the following error message appears:

This means that the PHP extension php_zip is not installed on your serve. You will need to install it or have it installed by your webhost.

If the installation is successful, the following message will appear:

The module will then appear in your list of modules under the Module tab.

Click on the install button to install the module.

If the Configuration note appears in the module insert, click on it to configure it.

Warning

If the store is open while the module has not been fully configured, it might be a good idea to deactivate it, especially if it’s a payment method module, by clicking on the green check.

Once the module is configured, click on the red X to reactivate it.

 

Install a module manually

 

Use this method if the manual installation does not work. It may seem tedious a priori for beginners, because it requires a certain amount of knowledge of FTP, etc., however it is no more complex and may even be more convenient because it works every time.

In addition, the know-how required for the installation is quite basic and is something that all store managers should master.

 

Install compression software

 

A PrestaShop module is supplied as an archive file in ZIP format. An archive consists of grouping several files and folders into one file, compressed or not compressed. An archive is created with the help of compression software, and such software is necessary to perform the reverse operation, that’s to say to remove the content of the archive in order to run it.

There are many varieties of compression software, some free, and some not. In order to run the content in our module, we will use the free 7zip (“sevenzip.”)

To download this program, go to http://www.7-zip.org/ and download the version that corresponds to your computer. If you use Windows, you will probably need the .exe 32 bits version. Once the installation file is downloaded, double-click below to launch the installation wizard.

Follow the installation wizard’s steps until the very end. You might need to reboot your computer at the end.

 

Extract the archive

 

A module consists of a folder containing all of the files and folders that make up the module. For example the module “my module” consists of a mymodule folder with files and eventually other folders, such as messages, images, etc.

Everything is then regrouped in a ZIP (compressed file) format archive. For example, my_module.zip . All PrestaShop modules are provided in ZIP format.

You must therefore extract the contents of this my_module.zip file to retrieve the module’s folder, because later we will only need this folder and its contents.

Note

Some confusion may occur, and the installation may fail. The chances of this happening depend on the way which the archive is extracted.

To extract an archive:

Right click on the module archive (my_module.zip).

In the menu that appears, choose: 7zip

We then have the my_module folder that was created to receive the archive content. THIS IS NOT THE FILE THAT WE WANT.

Opening this folder, we find the module file mymodule. THIS IS THE FOLDER THAT MUST BE TRANSFERRED TO THE STORE.

In general, according to the way in which the developer created the archive and the way in which the archive was extracted, the module’s folder could be found in one or several sub-folders. In any case, we will ignore the parent folders and only take those containing the module files.

For example, in the following image, the folders folder_1 to folder_4 will be ignored. We will only use the mymodule folder and its contents.

 

FTP Transfer

 

Transferring your module onto your hosting server is done using a protocol specially designed for transferring files over networks, called FTP (File Transfer Protocol).

To do this, you have two options:

- Your webhost offers you, in the webhost administration panel, an interface allowing you to perform FTP transfer of your module. If this is the case, you must connect to it and complete the transfer of the module in your store’s folder/modules.

- Your webhost give you the access codes to your webhost’s FTP account, and you must use software called “FTP client” to finish the transfer. That is what we will see below.

Certain webhosts can propose both solutions simultaneously. It’s up to you to choose which one works best for you.

 

Install an FTP client

 

One of the most popular free FTP clients is FileZilla. To download it, go to http://filezilla-project.org/download.php?type=client and download the version that you need. For Windows, you will generally need the win32-setup.exe version.

Once the installation file is downloaded, double-click below to launch the installation wizard.

Follow the installation wizard’s steps all the way to the very end. You may need to reboot your computer after the installation has completed.

 

Transfer Module

 

To transfer the module to your webhost, you must have the FTP connection identification keys supplied by your webhost. They are normally sent to you by e-mail. They can also be found in your administration panel.

To use the FileZilla software, we suggest that you follow the steps in the detailed guide supplied by OVH webhost support, found at http://guides.ovh.com/FtpFileZilla .

The module must be placed in the folder /modules in your PrestaShop store, as shown in the image below.

 

Install and configure the module

 

Once the module is placed in the server, you must install it into the store.

Connect to your store’s administration panel (Back Office), then in the tab Administration Panel—Modules, find the module and click on the button “Install.” If the installation is successful, a message should appear indicated “Module Installed.” Certain modules can be configured. If this is the case, a link Configure will appear in the module’s frame. Click this link to access the configuration interface.