User Guide for UnoPim AWS Integration

UnoPim AWS Integration connects UnoPim with Amazon S3 to make cloud storage of images and PDFs simple and secure.

Users can set it up easily using their Access Key ID, Secret Key, Region, and Bucket name.

It includes a feature that refreshes cached images at regular intervals so the latest media is always displayed.

If no refresh time is provided, a default value ensures updates still happen automatically.

New media files are synced to Amazon S3 on their own, while older files can be uploaded with just one click.

The integration offers scalable cloud storage with no limitations, supporting seamless media growth.

It optimizes media handling and ensures quick, dependable access to stored assets at all times.

• Connect UnoPim with Amazon S3 to store images and PDFs safely in the cloud.
• Set up quickly by entering Access Key ID, Secret Key, Region, and Bucket details.
• Auto-sync new images and PDFs to Amazon S3 without manual effort.
• Upload existing media files to the cloud with a one-click sync option.
• Set environment update time to control how often cached images refresh.
• Enable automatic cache refresh to reduce repeated AWS requests.
• Use default refresh time if no environment time is specified.
• Scale media storage effortlessly with unlimited cloud storage support.

To install the ‭UnoPim AWS Integration‬ extension, first download and unzip the extension.

Place the extracted folder in the “packages/Webkul” directory within the root of your project.

Register the package provider

Go to config/app.php file and add following line under ‘providers’

Webkul\AWSIntegration\Providers\AWSIntegrationServiceProvider::class,

Go to composer.json file and add following line under ‘psr-4’

"Webkul\\AWSIntegration\\": "packages/Webkul/AWSIntegration/src"

To complete the installation, run the following commands:

Dump composer autoload
composer dump-autoload

Install ‭UnoPim AWS Integration‬ extension

composer require league/flysystem-aws-s3-v3

Publish Plugin Assets

php artisan vendor:publish --tag=unopim-aws-connector

Clear application cache

php artisan optimize:clear

Kindly follow the steps mentioned below to create the Amazon S3 Credentials-

• Go to https://aws.amazon.com/ and click on Create an AWS Account.

• After that, you will get two options Create an AWS account for the new users and Sign in to an existing AWS account for the already registered users. 

So, when that user logs in he only has access to that particular dashboard. 

• After that, your Amazon server will look like this. Here you need to click on the All services – > S3.
• Alternatively, you can also search the S3 in the search box given at the top.

This will direct you to a page where you can see the list of the buckets that you have created or you can create a new one.

Click on the Create bucket button to create a new bucket.

• After clicking on the Create bucket button this Create bucket page will come up where you need to fill in all the details to create a new bucket.
• Then click Create bucket at the bottom.

Note:- Make sure to uncheck the “Block all public access”.

• Here you can upload the files and create a folder to save the data. Also, you can view the saved data.

• For creating access key ID and secret access key click on IAM under Security, Identity & Compliance

In the IAM dashboard click on Users to view and to delete the existing users and to add the new user.

• After that, a new page will open up where you have options to Add, View and Delete users.

• Click on the Security Credentials to create a new access key.
• Now you have to go for Access keys – > Create Access Key.
• Now you can see your Access Key ID and Secret access key generated as depicted below.

After installing the ‭UnoPim AWS Integration‬ module, users with the required permissions can manage the below mentioned configurations.

Navigate to the left-side menu and select AWS Integration > AWS Integration Section

Here, the user can enable the module to ‭allow files to save on amazon S3 cloud storage.

To successfully integrate AWS with UnoPim, the user must enter the following configuration details generated within their Amazon AWS account:

• Access Key ID
• Secret Key
• Bucket Name
• Region
• Bucket URL

The ‘Environment Update Time‘ field lets the user set how long (in seconds) images should be stored in the browser. The cache will only refresh after this time is over.

If you don’t set a time, the system uses a default of 86,400 seconds (24 hours).

This helps reduce repeated URL requests and avoids unnecessary fetches from AWS.

Navigate to the left-side menu and select AWS Integration > General Section

Click the ‘Synchronize‘ button to upload all existing images and PDFs to Amazon S3 with a single click.

Any new images or PDFs that are added later will be synced automatically.

Users can upload images and PDF documents as usual by going to Catalog > Products in UnoPim.

The files will automatically be moved to AWS, and S3 links will be generated for the media.

Moreover, the unlimited cloud storage provides seamless scalability and reliable access to all media files.

So, that was all about the ‭UnoPim AWS Integration‬ extension. for any queries or doubts reach out to us at support@webkul.com.

You can also raise a ticket at our HelpDesk System.