Filesystem

Overview

Shopware 6 stores and processes a wide variety of files. This goes from product images or videos to generated documents such as invoices or delivery notes. This data should be stored securely and backups should be generated regularly. Therefore, it is advisable to set up an external storage, which scales with the size of the data, is redundant and performs backups. In addition, for cluster setups with multiple setups, it is necessary to share the files via external storage so that each app server can access the corresponding data.

Flysystem overview

Shopware 6 can be used with several cloud storage providers, it uses Flysystem to provide a common interface between different providers as well as the local filesystem. This enables your shops to read and write files through a common interface.

The filesystem can be divided into multiple adapters. Each adapter can handle one or more of the following directories: media. sitemaps, and more. Of course, you can also use the same configuration for each and all of them:

  • One for private files: invoices, delivery notes, plugin files, etc

  • One for public files: product pictures, media files, plugin files in general

  • One for theme files

  • One for sitemap files

  • One for bundle assets files

Configuration

The configuration for file storage of Shopware 6 resides in the general bundle configuration:

<development root>
└── config
└── packages
└── shopware.yml

To set up a non default filesystem for your shop you need to add the filesystem: map to the shopware.yml. Under this key you can separately define your storage for the public, private, theme, sitemap and asset (bundle assets).

shopware:
filesystem:
public:
url: "{url-to-your-public-files}"
# The Adapter Configuration
private:
visibility: "private"
# The Adapter Configuration
theme:
url: "{url-to-your-theme-files}"
# The Adapter Configuration
asset:
url: "{url-to-your-asset-files}"
# The Adapter Configuration
sitemap:
url: "{url-to-your-sitemap-files}"
# The Adapter Configuration

Integrated Adapter Configurations

Local

shopware:
filesystem:
{ADAPTER_NAME}:
type: "local"
config:
root: "%kernel.project_dir%/public"

Amazon S3

shopware:
filesystem:
{ADAPTER_NAME}:
type: "amazon-s3"
visibility: "private" # Default is "public", can be set only on shopware.filesystem.private
config:
bucket: "{your-public-bucket-name}"
region: "{your-bucket-region}"
endpoint: "{your-s3-provider-endpoint}"
root: "{your-root-folder}"

For the usage of Minio, consider setting use_path_style_endpoint to true.

Google Cloud Platform

shopware:
filesystem:
{ADAPTER_NAME}:
type: "google-storage"
visibility: "private" # Default is "public", can be set only on shopware.filesystem.private
config:
bucket: "{your-public-bucket-name}"
projectId: "{your-project-id}"
keyFilePath: "{path-to-your-keyfile}"

Add your own adapter

To create an own adapter checkout the official Flysystem guide for that here.

To make your adapter available in Shopware you will need to create a AdapterFactory for your Flysystem provided adapter. An example for that could look like this:

<?php
use Shopware\Core\Framework\Adapter\Filesystem\Adapter\AdapterFactoryInterface;
use League\Flysystem\AdapterInterface;
class MyFlysystemAdapterFactory implements AdapterFactoryInterface
{
public function getType(): string
{
return 'my-adapter-prefix'; // This must match with the type in the yaml file
}
public function create(array $config): AdapterInterface
{
// $config contains the given config from the yaml
return new MyFlysystemAdapter($config);
}
}

This new class needs to be registered in the DI with the tag shopware.filesystem.factory to be useable.