Menu Close
    Hire us Request quote Reading list Switch to dark mode
    Blog Version - Akeneo 2.0.x, 2.1.x, 2.2.x , 2.3.x, 3.0.x, 3.1.x and 3.2.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x , 2.3.x, 3.0.x, and 3.1.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x , 2.3.x, 3.0.x, 3.1.x and 3.2.x

    Akeneo Amazon S3 Integration

    Introduction

    Akeneo Amazon S3 Integration: Connect your Akeneo platform with AWS Cloud Storage S3 for storing your catalog data. You can provide your Amazon S3 credentials in Akeneo Settings panel and do the integration easily. All the Akeneo product files and images will now be saved on AWS bucket.

    Please Note – Akeneo Amazon S3 Integration module is compatible with Community Edition, Enterprise Edition, and Cloud (PaaS/Flexibility) Edition of Akeneo.

    Basic Requirements:

    • This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x. Download Akeneo from here
    • Node and Yarn packages need to be installed.
    • Also works with Akeneo Cloud Flexibility Mode which is a PAAS Edition of Akeneo

    Features

    • Integrate Akeneo catalog storage to use Amazon s3 instead of File storage
    • Provide S3 credentials in Settings on Akeneo
    • There is no storage problem by using this.
    • Store the file and Images and integrate it with Akeneo
    • Generate the URL of the product images and files
    • Perfix can be be according to the you for catalog storage.
    • Added Aws visibility icon and message according to the Aws visibility.
    • Change visibility option on media view. It works only when the PutObjectAcl is given to Bucket.
    • Visibilty will change private or public.

    Video Tutorials

    Check out the following video tutorials below:

    Setup Credentials In Amazon S3

    Follow the below steps to create Amazon S3 Credentials to be used in Akeneo

    • Goto https://aws.amazon.com/ and click on the sign in to the console.
    • After it, you will get two option Sign in and create a new AWS account.
    • After it, your Amazon server will look like this. You have to click on the IAM.
    • Click on the all service – > S3. You can see the list of the bucket that you have created or you can create a new one.
    • After clicking on the create bucket button. You can see the window like this. Fill all the details and click create the bucket.
    • Here you can upload the files and create a folder to save the data.
    • For creating access key ID and secret access key Click on IAM.
    • Click on the manage security credentials.
    • After it, a new pop up will open where you have to select Get started with IAM Users.
    • Now you have to go for Access key – > Create New Access Key

    • Now you can see your Access Key ID and Secret access key generated.

    Note:

    • You have to make sure that putObject and putObjectAcl permissions are given to access-keys provided in Amazon AWS.
    • You can check it from IAm>Groups>group

    Module Installation

    Please follow these steps for installing Akeneo Amazon S3 Integration in your Akeneo PIM platform.

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

    • Goto app/AppKernel.php and add the following line in function registerProjectBundles()

    new Webkul\AwsIntegrationBundle\AwsIntegrationBundle(),
    • In the app/config/config.yml and add these lines after imports
     - { resource: "@AwsIntegrationBundle/Resources/config/config.yml" }
    • Goto app/config/routing.yml and add these lines at top of the file

    aws_integration:
        resource: "@AwsIntegrationBundle/Resources/config/routing.yml"
        prefix:   /
    
    • You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.

    composer --prefer-dist require aws/aws-sdk-php v3.5.0 -v; composer --prefer-dist require league/flysystem-aws-s3-v3 v1.0.6 -v;
    rm -rf ./var/cache/** && php bin/console pim:install:asset --env=prod && php bin/console assets:install web --symlink --relative && yarn run webpack && php bin/console d:s:u --force
    
    • You have to restart your web server like Apache, Nginx. Run the command for Apache web server.
    sudo service apache2 restart
    

    Migrate your Existing Akeneo data to Amazon S3

    Amazon S3 is the simple web interface to store a large amount of data and you can retrieve the data at any time, anywhere from the web.

    If you have a lot of data at Akeneo end and want to migrate these data to Amazon S3 then you can easily do it. You have to run this command for the same.

    php bin/console aws_integration:move_existing_files:s3

    If you are using Akeneo Enterprise Edition and want to export all your product assets to Amazon S3 then run this command.

    php bin/console aws_integration:move_existing_asset_files:s3
    

    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

      It means that a web pack is not installed in your system. Run the following command
      npm install --save-prod webpack
      npm install
      
    • Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
    • Clear your browser cache using ctrl+shift+r.

    Setup Credential in Akeneo

    After successfully installing the module in Akeneo, you need to set up the Amazon S3 API credentials in Akeneo. Please log into Akeneo and follow Aws Integration>Setting. In the Aws Region, you have to add the region of your store. You have to enter the value like

    • Aws Region
    • Aws key
    • AwsSecret
    • Aws bucket name
    • Catalog Storage Prefix
    • DAM Asset Storage Prefix

    .

    Creating a Product in Akeneo

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

    Product – Select this type for creating simple and virtual products.

    Product Model – Select this type for creating a configurable product with variations.

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

    Product Family – A family is a set of attributes that will be the same for all products belonging to a family. The product family represents products type, imposes product information structure and defines the list of attributes for a product that it belongs.

    Add Product Details

    Now you need to provide information about the product. First, select the Channel and Locale and then enter the details.

    After it, you can change the product images and files visibility in Akeneo. For it, you have to click on the icon showing in the image below. After clicking on it, you will get the notification Visibility Change to public Successfully or Visibility Change to private Successfully.

    If you enable the visibility you can see the product asset in the browser with asset URL.

    After clicking on the icon showing in the below image, you will get a link for the image at Amazon AWS Server. You can also save the files on the server.

    After clicking on the icon, you will get the link of product asset at Amazon S3 Server.

    Product in Amazon AWS Bucket

    After successful installing module, you can find the product images and files in Amazon AWS bucket and you can also use this link for other product creation. You can download the product and files and it is looking like it in Amazon S3.

    Support

    For any issues related to this module, please create a support ticket at- https://webkul.uvdesk.com/en/customer/create-ticket Also, for any pre-sales queries or customization discussion, please drop an email to support@webkul.com

    Current Product Version - Akeneo Amazon S3 Integration 1.0.6

    Supported Framework Version - Akeneo 2.0.x, 2.1.x, 2.2.x , 2.3.x, 3.0.x, 3.1.x and 3.2.x

    . . .

    Comments (6)

    Add Your Comment

  • Jörg
    Are all files (images and datasheets) stored in the same S3 bucket or does every asset type have its own?
    • saurav pathak
      Yes, all the files are stored in the same S3 bucket.
  • Nei
    What are the plans to make it 2.0 compatible?
    • Adarsh Shukla
      Hello Nei,
      Our Akeneo Amazon S3 Connector is already compatible with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, and 3.0.x. If you want more information about this connector then you can drop a mail on support@webkul.com
  • Perion
    When i have to run the composer command it requires a token, what should i do?
    • Adarsh Shukla
      You have to just click on the link given with the message. It will redirect you to Github where you will get an option to create the token. After generating the token, you have to enter the token in the terminal.
      Follow the link – https://github.com/settings/tokens
  • Back to Top
    css.php
    Hire Us!
    Brief us about your requirements and we'll get back to you.
    Woo! Hooy!
    We have just received your message and our expert will get back to you shortly.
    Send Again
    Close

    Table of Content

    Hide Index