Akeneo Amazon CloudFront Connector
Introduction
Akeneo Amazon CloudFront Connector: With the help of this extension, you can integrate Amazon CloudFront CDN with the Akeneo PIM platform.
After successful integration, the CloudFront CDN (Content Delivery Network) servers will be used for caching and serving media, images, PDF, and video files, etc. from product data.
Amazon CloudFront speeds up distribution of your static and dynamic web content, such as .html, .css, .php, image, and media files.
When users request your content, CloudFront delivers it through a worldwide network of edge locations that provide low latency and high performance.
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
- Use Amazon CloudFront for the images and files in Akeneo instead of File Storage
- You can connect Akeneo with Amazon CloudFront using the CloudFront domain name.
- Fast, highly secure and programmable Content Delivery Network(CDN)
- This module is compatible with latest Akeneo version 5.0.x
- Automatically save the image and files at Amazon CloudFront after installing the module.
- After using Amazon CloudFront in Akeneo, you can fetch the data from the nearest hub.
Setup Credentials for Amazon CloudFront
Follow the below steps to create the Akeneo CloudFront module credential to be used in Akeneo.
- For the Akeneo CloudFront credential first, you have to go to the link https://aws.amazon.com/. After it, you can click on Create an AWS account.
- You can create an AWS account. If you have any existing AWS account then you can click on Sign in to an existing AWS account. Here you can enter the account details.
- After successful login, your AWS account will be looking like this.
- Then you have to go the link https://console.aws.amazon.com/cloudfront/home with the same user id and password.
- After clicking on the CloudFront, you have to choose the delivery method for your content. Here you have to select Web then click on the Get Started.
- Then you have to click on the CloudFront. After it, you have to create CloudFront Distribution.
- Here you have to enter the details Origin Domain Name and Origin Pathname.
- After it, you have to click on the create distribution.
- Now you can see the created cloud distribution in the list. Here, you have to copy the domain name.
Module Installation 4.0.x to 5.0.x
1- Composer Installation
2- Manual Installation
Please follow these steps for installing Akeneo CloudFront Connector in your Akeneo PIM platform.
- Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.
- Goto config/Bundles.php then add the line:
Webkul\CloudFrontBundle\WebkulCloudFrontBundle::class => ['all' => true],
in return array.
3 – Copy the “config” folder into akeneo project root directory for routing.
- Run this command after ssh to your akeneo server by the terminal and navigating to Akeneo installation directory (ex. cd /opt/bitnami/apps/akeneo/htdocs)
php bin/console cache:clear --env=prod;php bin/console cloudfront:setup:install
- 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.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 2.x to 3.x
Please follow these steps for installing Akeneo CloudFront Connector in your Akeneo PIM platform.
-
- Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.
- Goto app/AppKernel.php then add the line
- Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.
new Webkul\CloudFrontBundle\WebkulCloudFrontBundle(),
-
- Goto app/config/routing.yml then add these lines at top of the file
- Goto app/config/routing.yml then add these lines at top of the file
webkul_cloud_front:
resource: "@WebkulCloudFrontBundle/Resources/config/routing.yml"
prefix: /
-
- Run this command after ssh to your akeneo server by the terminal and navigating to Akeneo installation directory (ex. cd /opt/bitnami/apps/akeneo/htdocs)
php bin/console cache:clear --env=prod;php bin/console cloudfront:setup:install
-
- 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 Issue 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
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 Credentials in Akeneo
After successfully installing the module in Akeneo, you need to set up the Amazon CloudFront credentials in Akeneo. Please log into Akeneo and follow CloudFront Configuration -> Configs. Then here you have entered the CloudFront domain name.
Create Products in Akeneo
To create a product in Akeneo, go to navigate to 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.
Now enter the required SKU, choose a family, then 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 to.
Add Product Details
Now you need to provide information about the product. First, select the Channel and Locale then enter the details.
After that, click on the download button then you can see the Amazon CloudFront URL there.
You can also open the image in the browser with the asset link.
Support
For any issues related to this module, please create a support ticket at our HelpDesk System. Also, for any pre-sales queries or customization discussion, please drop an email to support@webkul.com.
Please explore our Akeneo Development Services and Quality Akeneo Extensions.