How to store assets externally¶

Quick Overview¶

This cookbook will demonstrate you how to store the assets of the Asset Manager on a distant storage. Assets are specific files available only in the Enterprise Edition. But you can apply the exact same cookbook to store your product medias elsewhere.

This cookbook assumes that you already configured an external server. This cookbook should be done before the installation of the PIM. Otherwise you will have to migrate your data to your external server.

When connecting to an external server for storage, reference files and variations are created on the external server. The structure of the folders in which files are stored comes from the PIM. Only thumbnails are stored on the PIM server.

Use a SFTP server¶

Let’s assume that you already have a fully functional SFTP server ready to receive files.

# config/packages/prod/oneup_flysystem.yml
oneup_flysystem:
    adapters:
        asset_storage_adapter:
            sftp:
                host: ftp.domain.com
                port: ~
                username: ~
                password: ~
                root: ~
                timeout: ~
                privateKey: ~
                permPrivate: ~
                permPublic: ~

Note

Don’t forget to add your SFTP credentials.

Note

If you want to change the way your product media are stored, you have to configure the key catalog_storage_adapter instead of asset_storage_adapter.

For further information about SFTP adapter check Sftp adapter.

Use Amazon AwsS3v3 as storage¶

First of all, you will need to install the following requirements:

composer --prefer-dist require aws/aws-sdk-php v3.5.0

composer --prefer-dist require league/flysystem-aws-s3-v3 v1.0.6

In order to use the AwsS3v3 adapter, you first need to create a client object defined as a service:

# config/services/prod/storage.yml
services:
    Aws\S3\S3Client:
        arguments:
            -
                version: '2006-03-01'
                region: "region-id" # 'eu-central-1' for example
                credentials:
                    key: "s3-key"
                    secret: "s3-secret"

Note

As per AWS Documentation recommendation, do not use ‘latest’ version in a production environment. More information in Awss3 documentation. All versions available are documented in AWS SDK for PHP.

Then configure the asset storage adapter to use the service you declared:

# config/packages/prod/oneup_flysystem.yml
oneup_flysystem:
    adapters:
        asset_storage_adapter:
            awss3v3:
                client: 'Aws\S3\S3Client'
                bucket: 'mybucket'

Note

Don’t forget to add your credentials and the region-id

Note

Don’t forget to add the bucket name

Note

If you want to change the way your product media are stored, you have to configure the key catalog_storage_adapter instead of asset_storage_adapter.

For further information about AWS adapter check Awss3 adapter.

Other¶

You can find more information about adapters in Flysystem documentation.

Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!