Back to Top

Akeneo Image Gallery

Updated 13 May 2024

Introduction

Akeneo Image Gallery allows you to add/manage images into various galleries and galleries into various groups according to requirements.

You can easily manage photo galleries and gallery groups on their site.

If you want to use OpenAI to create images for your product, have a look at Akeneo AI Image Generator.

Watch the video to understand the plugin workflow:-

Features

  • Create a Media Gallery with multiple images, alts, and title descriptions, and assign groups.
  • Create Group which will be used in Media Gallery.
  • Export/Import Media Gallery
  • Create a Media Gallery attribute and use it in the product family.
  • Re-design your images with the UI tool.
  • Can give permission to a different user to manage the image gallery.
  • Select the preferred URL for the public thumbnail during import.
  • Using the file CSV publication for the image description and thumbnail
  •  Enable/disable favorites in the Gallery grid

Basic Requirement

  • Akeneo Image Gallery module works with Akeneo 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x, 6.0.x, and 7.0.x.
  • This module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
  • If you want to use this extension on Akeneo EE Serenity mode, please contact us.
  • For the Akeneo installation, your Akeneo server should meet these system requirements.

Installation

Two different types of module installation processes are available for the module.

Searching for an experienced
Akeneo Company ?
Find out More
  1. Composer Installation
  2. Manual Installation

Installation using Composer Installation

Read This Blog

Before beginning the composer installation

1: Get the ACCESS KEYS [Create a support ticket]

2: In Akeneo composer.json, add our repository and the installation script.

For Akeneo 6.x and 7.x

{
  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/imagegallerybundle/src/Webkul/ImageGalleryBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-install-cmd": [
           "vendor/webkul/imagegallerybundle/src/Webkul/ImageGalleryBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/imagegallerybundle/src/Webkul/ImageGalleryBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

For Akeneo <=5.x 

{
  "scripts": {
        "post-update-cmd": [
           
"vendor/webkul/imagegallerybundle/composer_install.sh"
        ],
        "post-install-cmd": [
           
"vendor/webkul/imagegallerybundle/composer_install.sh"
        ],
        "post-create-project-cmd": [
         
"vendor/webkul/imagegallerybundle/composer_install.sh"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

3: Use composer to install the extension

         composer require webkul/imagegallerybundle

4: Complete the authentication form.
5: Send a Message of Success
6: Delete your browser’s cache.

Manual Installation for Version 6.x and 7.x

  •  After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
  • From the PIM directory, run the following command over the NO-DOCKER Instance.
./src/Webkul/ImageGalleryBundle/install/config.sh COMPOSER=false NO_DOCKER=true
  • After that run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/ImageGalleryBundle/install/config.sh COMPOSER=false NO_DOCKER=false

Manual Installation for Version 4.0.x to 5.x

Please follow these steps for installing Akeneo Image Gallery module in your Akeneo PIM platform.

1 – Unzip the respective extension zip  then merge the “src” folder into akeneo project root directory.

Screenshot-by-Lightshot

2 – Goto config/Bundles.php then add line:

Webkul\ImageGalleryBundle\ImageGalleryBundle::class => ['all' => true],

in return array.

3 – Copy the “config” folder into akeneo project root directory for routing.

Screenshot-by-Lightshot-1

– Run this command after ssh to your akeneo server by the terminal.

php bin/console cache:warmup && php bin/console wk-gallery:setup:install

5– If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

For Akeneo 5

sudo service php-fpm7.3 restart

For Akeneo 4

sudo service php-fpm7.3 restart

Docker Installation Command :

For Akeneo 5

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run update-extensions;
docker_yarn run less;

For Akeneo 4

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run less;

Manual Installation For Version 2.x to 3.x

Please follow these steps for installing Akeneo Image Gallery module in your Akeneo PIM platform.

1 – Unzip the respective extension zip  then merge the “src” folder into akeneo project root directory.

src-magento-2-1

2 – Goto app/AppKernel.php then add line:

new Webkul\ImageGalleryBundle\ImageGalleryBundle(),

3 – Goto app/config/routing.yml then add these lines at top of file Syndication: resource:

image_gallery:
  resource: "@ImageGalleryBundle/Resources/config/routing.yml"
  prefix:   /

5 – Run this command after ssh to your akeneo server by the terminal.

php bin/console cache:warmup && php bin/console wk-gallery:setup:install

6 – If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

sudo service php-fpm7.2 restart

Common Issues After Installation

It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:

  • Webpack Installation: If you get the below error
Webpack-error-1

Uninstall Module: For Akeneo 6.x and 7.x

  • From the PIM directory, run the command below over the NO-DOCKER Instance.
./src/Webkul/ImageGalleryBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true
  • Run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/ImageGalleryBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

Set up in Akeneo

After installation of the module in Akeneo, you have to create the gallery Group attributes. You have to navigate Setting-> Attribute -> Create Attribute.

Attributes-16

After that, click on Create attributes then select click on Akeneo Image Gallery.

Akeneo-image-gallery-attribute

Now after clicking on the attribute, you have to enter the details.

Attribute-Image-Gallery-locale-wise-Germany-Edit

For creating the product in Akeneo, you have to choose the family. So, you can assign the asset group attribute in a product family.

Family-Accessories-Edit-6

After the installation in Akeneo, You will find the Gallery icon.

Dashboard-15

After it, you have to click on the Gallery Icon then a new page will open then you have to click on “Image Gallery” button

Webkul-Gallery-Index

You will find the add gallery and add group icon at the right of the screen.

gallery

Click on add group to create a new group.

Webkul-Gallery-Group-Code

After that, a new page will open. Fill in the code then click on to Save button.

Webkul-Gallery-Group-Code-1

Now to create a new gallery click on add gallery button.

add-gallery

After that enter, the code then click on to Save button.

Webkul-Gallery-Index-3

Now clicking on the save button, the gallery management page will open. Here, you can upload the media.

media

After uploading the media, you can edit the asset with the media gallery module. In that, you can select the images thumbnail images as well as you can add a description of each image.

tumbnail

After clicking on the edit button, the image edit page will be open.

edit image

You can also add information about the media.

  • Add To Favourites – You can enable the favorite icon. With it, You can filter the media.
  • Title – Asset title explains about the media.
  • Alternative text – With alternative text, you can add further more information about the media.
  • Description – It describes the product media.
Webkul-Gallary-Asset-Edit-1

  • Expiration Date – In this, you have to select the date by which the gallery will expire.
  • Gallery Tag – These gallery tags will help you while filtering the products.
  • Gallery Group – Select the group in which you want to assign the gallery.
tag

You can click on the save button on the right corner of your page. Now you can see the gallery is added to the Gallery list.

After saving the gallery in the Gallery list, you can edit,change favourites status and delete the gallery.

add faviourate

In Akeneo Media Gallery module, You can filter the gallery with the

  • Created At
  • Updated At
  • Favorites
  • Description
  • Groups
  • Tags
filter

Filter With Created Time:

In this module, You can filter the gallery with created time. For this, you have to choose the operators.

  • Between – You can filter the asset that you have created between two dates.
  • Not Between – Can filter the asset that you have not created between two dates.
  • More than – You can filter the asset after the selected date.
  • Less than – You can filter the asset before the selected date
created at

Filter With Updated Time:

In this module, You can filter the asset with updated time. For this, you have to choose the operators.

  • Between – You can filter the asset that you have updated between two dates.
  • Not Between – Can filter the asset that you have not updated between two dates.
  • More than – You can filter the asset after the selected date.
  • Less than – You can filter the asset before the selected date.
updated at

Filter The  Favourites:

In this module, You can set the favorites asset. With it, you can filter the products. You will find three options on it.

  • All – You can filter the all favorites and not starred products.
  • Yes – Can filter all favorites products.
  • No – You can filter the not favorites products.
favourites

Filter With Description:

In this module, You can filter the asset with description. For this, you have to choose the operator.

  • Contains – The product description contains the text entered by you.
  • Does not contain – The product description doesn’t contain the text entered by you.
  • Is equal to – The product description is equal to the text entered by you.
  • Starts with – The product description starts with the text entered by you.
  • Is Empty – The product description is empty.
description
Filter The Gallery Group: 

Gallery groups can be used to filter the asset. After clicking the group icon, all of the groups will be displayed.The gallery of the selected group will be listed.

Group

Tags:

You can filter the asset with tags. All the tags will be visible after clicking on the tags icon.The gallery of the selected tags will be listed.

tag

If you want to delete the gallery in bulk, select the option (all, all visible, or none) and click delete.

bulk

To create a product in Akeneo, go to navigate to Products and click the Create button. Now, you need to choose product type – as Product or Product Model.

Products-19

Now you have to enter the required SKU, choose a family, and click the Save button.

Products-34

You can add/upload a gallery to the product with the gallery group attribute.

Product-Sunglasses-Edit-1

Now, after clicking on the ADD/UPDATE button, you have to select the gallery that you want to add to the product.

add image

By selecting the checkbox next to the thumbnail, you may select all of the galleries. You can also filter the galleries by created at, updated at, groups and tags.

filter

After selecting the gallery, click on the confirm button. 

select

After adding the gallery, click on the confirm button. Your product details will be shown on the product page.

If you want to remove the background of your product image, you can check Akeneo Image Background Remover.

add -images
Create Export Job Profile

You can export assets from Akeneo Media Gallery Extension you can create an export profile.

To create a new export job profile, go to Exports>Create Export Profile

Export-profiles-management-15

After that enter a code, label, and select job type to create new job profile.

Export-profiles-management-16

After that click to Save button then enter the details:

  • Delimiter
  • Enclosure
  • With header
  • Image gallery code – You can enter detail in the filter if you wan t to export the particular gallery
filter

Then click to Export Now to run the export job.

Export-profile-Akeneo-Image-Gallery-CSV-Export-Show

After running the export job there will be an option to Download Generated File click on that to create a CSV file. You can generate a file or zip.

Process-tracker-Show-job-20

Akeneo Media Gallery Import

To create a new import job profile, go to Imports>Create Import Profile.

Note: If tumbnail is not entered while importing a product in a CSV file, the first image will be imported as tumbnail.

Import-profiles-management-10

After that enter a code, label, and select job type to create the import job.

Import-profiles-management-11

Then click to Save button.

After that there will be two option –

  • Import Now – In this you can enter the file path to import the asset.
  • Upload a file – In this you can drag the file to import the asset.
Import-profile-Akeneo-Image-Gallery-CSV-Import-Show

After uploading the file click to the Upload and Import Now option. Then uploading and running the export job you can check the execution details.

Process-tracker-Show-job-21

Support

So, that was much about the User Guide of the Akeneo Image Gallery module for any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.

Please explore our Akeneo Development Services and Quality Akeneo Extensions.

Current Product Version - Akeneo 3 to 6 || 4.1.0 Akeneo 7 || 4.2.0

Supported Framework Version - Akeneo Version: 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x,6.0.x, and 7.0.x.

. . .

Leave a Comment

Your email address will not be published. Required fields are marked*


Be the first to comment.

Back to Top

Message Sent!

If you have more details or questions, you can reply to the received confirmation email.

Back to Home

Table of Content