Getting Started

Before starting and purchasing extensions please read carefully the documentation to see if these extensions cover your needs.

Each extension is available in Magento Marketplace individually.

Warning

Multiple Filesystems for Core Modules (bb/filesystem-overwrites) ``- NOT PUBLISHED YET`` is currently on the alpha phase so it will possibly affect some of Magento core features or 3rd party modules.

The following modules bb/filesystem-cms bb/filesystem-catalog and bb/filesystem-downloadable are shared packages for Multiple Filesystems for Core Modules (bb/filesystem-overwrites) ``- NOT PUBLISHED YET`` and are offered for free. Those modules consist of code fixes in Magento Core modules where Filesystem drivers are not used accordingly, by using the Filesystem object.

Important

There is a further plan to integrate all Magento Community improvements into the core codebase. By purchasing this extension will move forward this project and plan for achieving better filesystem abstraction in Magento 2 platform.

Software dependencies

Bellow you will find both the extension commercial name and the module name (in parentheses), short description of the extension and the dependencies within the extension group, dependency on other Magento modules, and also the dependency on PHP extensions or other software dependency.

Remote Filesystem Integration (bb/filesystem)

This is the main module, implementing configuration management and extensibility, shortly, most of the business logic for remote filesystem integration:

  • directories mapping
  • configure new remote media directories for new modules (e.g.: you want to store some reports in Azure Blob storage, you can configure a new directory for this report)
  • use the media storage system of your choice for any given directory or subdirectory
  • image resize in-place without sync back to local filesystem (this require having the same configuration for the main directory and the destination of resized files)
  • OOB this module can be used in custom modules, none of Magento core features are touched

Important

Dependencies
  • Magento Modules
    • MagentoFramework
    • MagentoMediaStorage
    • MagentoStore
  • Other extensions for Magento
    • N/A
  • PHP extensions
    • N/A

Amazon S3 Integration Filesystem Driver (bb/filesystem-s3)

  • implementation of Amazon S3 like API as a Magento filesystem driver

Important

Dependencies

Multiple Filesystems for Core Modules (bb/filesystem-overwrites) ``- NOT PUBLISHED YET``

  • allows bb/filesystem features on built-in media directories

Important

Dependencies

bb/filesystem-cms ``- NOT PUBLISHED YET``

  • configure Magento_Cms module to use bb/filesystem
  • fix some weak points on Magento core components that are not using driver object to execute basic actions on files

Important

Dependencies

bb/filesystem-catalog ``- NOT PUBLISHED YET``

  • configure Magento_Catalog module to use bb/filesystem
  • fix some weak points on Magento core components that are not using driver object to execute basic actions on files

Important

Dependencies

bb/filesystem-downloadable ``- NOT PUBLISHED YET``

  • Allow downloadable files to be saved in a different non-public media storage
  • fix some weak points on Magento core components that are not using driver object to execute basic actions on files

Important

Dependencies

Installation process

From source

In case you decide to install the extension from source (usually from sourced downloaded from Magento Marketplace) you need to unzip the files inside code directory creating proper subdirectory for module. This method is working but for extended support and regular updates use composer installation.

Using composer

In case you need filesystem integration only for custom development:

{
    "...",
    "require": {
        "bb/filesystem": "x.*",
        "bb/filesystem-s3": "x.*"
    },
    "..."
}

If you want to have mapping for Magento core directories you should also add bb/filesystem-overwrites module.

{
    "...",
    "require": {
        "bb/filesystem": "x.*",
        "bb/filesystem-s3": "x.*",
        "bb/filesystem-overwrites": "x.*"
    },
    "..."
}

Install new modules

composer install
bin/magento setup:upgrade

Not mandatory, once you buy the extensions from Magento Marketplace you can request access and register the private composer repository, to have access as soon as possible to new or beta versions:

{
    "repo.asset42.com": {
        "username": "<username>",
        "password": "<password>"
    }
}

Contribution

One way of contributing to this project is by creating a local repository with your original code version you are using on your installation (vx.x.x):

$ git init
$ git commit -m "original version"

Make the changes your are planning to submit, and create a patch file with those changes:

$ git diff --no-prefix > describe-problem-vx.x.x.patch

// you also can apply the path on your installation until the issue will be fix
$ patch -p0 < describe-problem-vx.x.x.patch