The DAM Connector Pack modules allow you to connect to your external DAM and make your existing assets, including videos, PDFs and images, available directly within Magnolia.
|Provides the foundation for integrating with S3 and Bynder and a sample component for using assets in the Pages app.|
|Provides a default implementation to connect to Bynder.|
|Provides a default implementation to connect to Amazon S3.|
Maven is the easiest way to install the modules. Add the following dependencies to your webapp. All the other necessary dependencies will be brought in automatically:
<dependency> <groupId>info.magnolia.external.dam</groupId> <artifactId>magnolia-external-dam</artifactId> <version>1.0</version> </dependency>
<dependency> <groupId>info.magnolia.external.dam</groupId> <artifactId>magnolia-external-dam-bynder</artifactId> <version>1.0</version> </dependency>
<dependency> <groupId>info.magnolia.external.dam</groupId> <artifactId>magnolia-external-dam-s3</artifactId> <version>1.0</version> </dependency>
This section explains how to configure the connection between the External DAM module and your external asset management solution. Essentially, you:
- Provide connection credentials for your external solution.
- Configure the cache if necessary.
You can create or edit the configuration in the JCR or the File System (YAML) under
Before you configure the connection, make sure you know:
- Which solution you want to connect to. Default implementations are provided for:
- AWS S3
- Connection credentials for your solution.
AWS S3 connection configuration
To use AWS S3 assets in Magnolia, you must have a working AWS account.
You need AWS S3 credentials to connect your S3 buckets and display their content in Magnolia. Credentials consist of two parts:
- AWS access key ID
- AWS secret access key
Add these credentials to your Magnolia instance in the Password manager app. For example:
magnolia-aws-foundation module handles all Amazon connections from Magnolia. This module is installed automatically by Maven when you install the External DAM module.
Configuring an AWS S3 bucket whitelist
By default, all the buckets in the S3 account you connect to are displayed. If you do not want to display all your buckets, you can configure a whitelist under
/dam-s3/config.yaml using regex.
Bynder connection configuration
To use Bynder assets in Magnolia, you must have a working Bynder account.
You need a permanent OAuth 2.0 API token from Bynder to access the assets.
To generate a token, see this Bynder documentation: https://help.bynder.com/system/oauth2-permanent-tokens.htm.
You can use the token value directly in the yaml configuration or add the permanent token to your Magnolia instance in the Password manager app and reference the path in the configuration. For example:
Add your connection configuration under
URL to your Bynder service.
A permanent OAuth 2.0 API token from Bynder or the path to the Passwords app where the token is stored.
Configuring the cache
This connector pack uses Caffeine, a high-performance Java cache library, to manage caching for external assets via a Magnolia helper module called
For Bynder and S3 caching, you can specify the behavior of the caches. Essentially, you can configure all the parameters available in CaffeineSpec. For example:
- Set a maximum cache size.
- Define how often the cache expires.
Additionally, you can:
- Enable or disable the cache.
You configure caching through decoration under
Bynder default configuration
S3 default configuration
Cache configuration properties
Use CaffeineSpec properties to specify the cache behavior such as the maximum size of the cache and when cache entries expire for each cache.
Bynder loading times
Note that the Bynder API may be very slow in some regions. For example, one image upload may take up to 20 seconds in EU regions. This may cause some actions to fail in the Magnolia UI and the cache to be invalidated.For more information, see https://github.com/Bynder/bynder-js-sdk/issues/43.
magnolia-external-dam submodule provides a sample Text and external image page component so that editors and marketers can select and use external assets in the Pages app. See DAM Connector Pack for an example.