Menu Close
    Searching for an experienced Akeneo Development Company ?

    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 the Akeneo Settings panel and do the integration easily. All the Akeneo product files and images will now be saved on the AWS bucket.

    Note: For the Akeneo Amazon S3 setup, you can follow this user guide: S3 bucket and policy setup for Akeneo AWS Connector

    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, 3.2.x, 4.0.x and 5.0.x. Download Akeneo from here
    • Node and Yarn packages need to be installed.
    • 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.

    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
    • The prefix can be according to you for catalog storage.
    • This module is compatible with the latest Akeneo version 5.0.x
    • 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.
    • Visibility will change private or public.

    Video Tutorials

    Check out the following video tutorials below:

    How to connect Akeneo with Amazon S3 serve

    SNBMDWT6-bA

    Setup Credentials In Amazon S3

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

    • Goto https://aws.amazon.com/ then click on the sign in to the console.
      AWS account
    • After it, you will get two option Sign in then create a new AWS account.
      AWS sign in option
    • After it, your Amazon server will look like this. You have to click on the IAM.
      AWS services
    • 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.
      All Services
    • After clicking on the Create bucket button. You can see the window like this. Fill all the details then click create the bucket.
      Create bucket
    • Here you can upload the files then create a folder to save the data.
      Upload files and create folder
    • For creating access key ID and secret access key Click on IAM.
      Access key id and secret access key
    • Click on the manage security credentials.
      Manage security credential in Akeneo
    • After that, a new pop up will open where you have to select Get started with IAM Users.
      Get Started with I am User
    • Now you have to go for Access key – > Create New Access Key
      Create a new access key
    • Then you can see your Access Key ID and Secret access key generated.
      Download key file

    Note:

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

      Permissions

    Module Installation for Version 4.0.x to 5.0.x

    Install the connector dependencies:

    For Akeneo 5

    php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require aws/aws-sdk-php v3.172.0 -v;
    
    php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require league/flysystem-aws-s3-v3 v1.0.6 -v;

    For Akeneo 4

    php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require aws/aws-sdk-php v3.5.0 -v;
    
    php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require league/flysystem-aws-s3-v3 v1.0.6 -v;

    After that please follow these steps for installing Akeneo Amazon S3 Integration in your Akeneo PIM platform.

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

    sr-amazon-s3

    • Goto config/Bundles.php then add line:
    Webkul\AwsIntegrationBundle\AwsIntegrationBundle::class => [ 'all'=> true],

    amazon-appkernal

    in return array.

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

    conf-amazon

    •  Run this command after ssh to your akeneo server by the terminal
    php bin/console cache:clear--env=prod;php bin/console aws:setup:install
    • If you are using php-fpm. Then you need to restart the php-fpm services.

    For Akeneo 5

    sudo service php-fpm7.4 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;

    Module Installation for Version 2.x to 3.x

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

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

    sr-amazon-s3

    • After that goto app/AppKernel.php then add the following line in function registerProjectBundles()

    AppKernel.php

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

    Routing.yml 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.
    php bin/console cache:clear--env=prod;php bin/console aws:setup:install

    • If you are using php-fpm. Then you need to restart the php-fpm services.

      sudo service php-fpm7.2 restart

    Migrate your Existing Akeneo data to Amazon S3

    Amazon S3 is the simple web interface to store a large amount of data then 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
      Webpack 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
      Page loader doesn't stop
    • 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 then you have to enter the value like

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

    .setting

    Creating a Product in Akeneo

    After that to create a product in Akeneo, go to the Products then click the Create button. Now, you need to choose the 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.

    create a product in Akeneo

    Then enter the required SKU, choose a family, after that 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 product type, imposes product information structure, and defines the list of attributes for a product that it belongs.

    Create a product family

    Add Product Details

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

    Product details

    After that, you can change the product images and file 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 the asset URL.

    product details

    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.

    Click here for the link

    After clicking on the icon, then you will get the link to the product assets at Amazon S3 Server.

    edit the image

    Product in Amazon AWS Bucket

    After successfully installing the module, you can find the product images and files in the Amazon AWS bucket after that you can also use this link for other product creation.

    Then you can download the product and files and it is looking like it in Amazon S3.

    product image

    Support

    Thank you for reading this documentation. So, that was much about the User Guide of Akeneo Amazon S3 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 Amazon S3 Integration 2.0.0

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

    Blog Version - Akeneo 2.0.x, 2.1.x, 2.2.x , 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x and 5.0.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, 3.2.x, 4.0.x and 5.0.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x , 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.0.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
    . . .
    Discuss on Helpdesk

    Leave a Comment

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


    10 comments

  • Ben
    Hi!

    Can i use the connector, if the data is not on a amazon s3 server directly but on a inhouse server? (its still using the s3 server architecture)

    Thanks

    • Adarsh Shukla (Moderator)
      Hello Ben,
      You can connect your Akeneo Amazon S3 server directly with Akeneo. We are using Amazon S3 endpoints to export the images from Akeneo to the S3 server. So, there will be some requirements to connect the S3 server with Akeneo like AWS region, Access key ID, Secret key, Bucket name.
      First, you need to check with the AWS S3 CLI tool if the S3 CLI tool works fine then it will work.
      Please let me know if you have further any query. You can raise a ticket: https://webkul.uvdesk.com/en/
      You can also connect us over skype: https://bit.ly/Akeneo-Shopware-Pimcore
  • Frederick
    Hello,
    After installation I don’t see the link icons (or any other icons) to go to AWS
    • Adarsh Shukla (Moderator)
      Hello Frederick,
      After the installation of the S3 module and saving the credential, you can see the icon to generate the S3 link on the media files. For any issue, please drop a mail on [email protected]
  • Jörg
    Are all files (images and datasheets) stored in the same S3 bucket or does every asset type have its own?
    • saurav pathak (Moderator)
      Yes, all the files are stored in the same S3 bucket.
  • Nei
    What are the plans to make it 2.0 compatible?
    • Adarsh Shukla (Moderator)
      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 [email protected]
  • Perion
    When i have to run the composer command it requires a token, what should i do?
    • Adarsh Shukla (Moderator)
      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

    Table of Content

    Hide Index