wwwision/neos-assetsource-pimcore

Pimcore asset source for Neos CMS

1.3.0 2023-04-18 08:22 UTC

Requires

• php: >=7.4
• ext-json: *
• guzzlehttp/guzzle: ^7.3
• neos/neos: ^7.0 || ^8.0
• webmozart/assert: ^1.10

Requires (Dev)

• phpunit/phpunit: ^9.0
• roave/security-advisories: dev-latest

GPL-3.0-or-later

README

Pimcore asset source for Neos CMS

Setup

Install package via composer

composer require wwwision/neos-assetsource-pimcore

Configure Pimcore asset source

In a global (or site specific) Settings.yaml:

Neos:
  Media:
    assetSources:
      'pimcore':
        assetSource: 'Wwwision\Neos\AssetSource\Pimcore\AssetSource\PimcoreAssetSource'
        assetSourceOptions:
          label: 'Pimcore'
          description: 'Pimcore Asset Source'

          api:
            baseUrl: '<https://pimcore-base.url>'
            endpoint: '<datahub configuration name>'
            apiKey: '<datahub api key>'

Note: Additional options for the HTTP client can be defined via additionalConfiguration. For example in order to disable SSL checks:

Neos:
  Media:
    assetSources:
      'pimcore':
          # ...
          api:
            # ...
            additionalConfiguration:
              verify: false

(Optionally) disable Neos asset source

If the Pimcore asset source should be used exlusivly, the built-in "neos" asset source can be disabled globally via Settings.yaml:

Neos:
  Media:
    assetSources:
      'neos': ~

Pimcore

For the Pimcore API to work with this package, the following steps are required

Active GraphQL configuration

A Datahub GraphQL configuration is required with Read access to the Assset, Asset Folder and Asset Listing types at least

Image Thumbnail configurations

Two image thumbnail configurations should be created, in order to provide a good UX in the Neos backend:

• thumbnail with a Contain transformation of 250x250 px
• preview with a Cover transformation of 1200x1200 px

Alternatively, the thumbnailConfigurationName and/or previewThumbnailConfigurationName options can be specified to use different thumbnail configurations:

Neos:
  Media:
    assetSources:
      'pimcore':
          # ...
          api:
            # ...
            thumbnailConfigurationName: 'gallery-thumbnail'
            previewThumbnailConfigurationName: 'gallery-full-width'

Acknowledgements

The development of this package was generously sponsored by Marktplatz GmbH - Agentur für Web & App. Thank you for supporting Open Source development!

Contribution

Contributions in the form of issues or pull requests are highly appreciated

License

See LICENSE