How do I configure asset rendering in Acquia DAM?

How do I configure asset rendering in Acquia DAM?

The Acquia DAM module version 1.1.x provides two methods to render assets on your Drupal website. Select the method that best fits your site's requirements for performance, storage, and access control.

Asset render methods

Embed for CDN delivery

Assets are served directly from the Acquia DAM CDN with embed codes. The asset files remain in Acquia DAM and are delivered to visitors through iframes or direct URLs.

• Best for: Most websites, public content, high‑traffic sites
• Benefits: CDN performance, no local storage required, and updates are reflected without file re-downloads.
• Limitations: No private file access through the private file system of Drupal.

This is the default and recommended method for most implementations.

 Download and sync

Assets are downloaded from Acquia DAM and stored locally in your Drupal file system. The module keeps local copies synchronized when assets are updated in Acquia DAM.

• Best for: Private content, restricted access, offline or internal‑only requirements
• Benefits: Full Drupal file system integration, private file support, complete image style support
• Limitations: Requires storage space, additional download, and sync overhead

Use this method when you need to restrict access to assets with Drupal’s permission system or serve assets from private file storage.

Configure embed for CDN delivery

Embed codes serve assets directly from Acquia DAM’s CDN. This method does not store files locally in Drupal and relies on Acquia DAM for file delivery.

How embed render works

After you use the embed codes:

• Assets remain in Acquia DAM.
• Drupal stores only asset metadata and references.
• Visitors receive assets through iframes or direct CDN URLs.
• The Acquia DAM CDN handles all file delivery.
• Assets use the latest available version from Acquia DAM that the integration detects during sync.

Configure a media type for embed render

To configure a media type to use embed render:

1. In the administrative menu, select Structure.
2. Select Media types to access all media types.
3. Locate a media type that uses the Acquia DAM media source, then select Edit.

4. In the Media source configuration section, ensure that the Download and sync assets checkbox is empty.

   
5. Select Save to store the configuration.

The media type now serves assets with embed codes from the Acquia DAM CDN.

Configure embed code display

To configure the display of embed‑based assets:

1. In the administrative menu, select Structure.
2. Select Media types, then select Manage display for your media type.
3. Locate the Asset reference field.
4. In the Format column, select Embed code.
5. Select the gear icon to configure embed options.
6. In the Embed style list, select your preferred rendering option.
7. Configure additional options such as thumbnail width.
8. Select Update, then select Save to store the display configuration.

Configure download and sync

Download and sync store asset files locally in your Drupal file system. This method downloads files from Acquia DAM and keeps them synchronized after assets update.

How download and sync work

After you enable download and synchronization on a media type:

1. Assets are downloaded from Acquia DAM to your Drupal file system.
2. Files are stored in either public or private file directories.
3. Drupal serves assets directly from the local file system.
4. After an asset update in Acquia DAM, updated files are re-downloaded during cron runs or through manual/Drush triggers.
5. You have full control over file access through Drupal’s file and permission system.

When to use download and sync

Use this method to:

• Control access to assets with the permission or role system of Drupal.

• Serve files through public or private file systems of Drupal rather than directly from the Acquia DAM CDN.

• Integrate with file management and private file handling of Drupal.

Configure a media type for download and sync

To enable download and synchronization on a media type:

1. In the administrative menu, select Structure.
2. Select Media types to view all media types.
3. Locate a media type using the Acquia DAM source, then select Edit.
4. In the Media source configuration section, check the Download and sync assets checkbox.
5. In the Upload destination section, select a file storage option:
   • Public files: Assets are accessible through direct URLs and do not require Drupal access checks.
   • Private files: Assets are served through Drupal with access checks, respecting Drupal’s permission system.

6. To restrict which file extensions are downloaded, enter them in the Allowed file extensions field. Leave this field empty to permit all extensions.

   
7. Select Save to store the configuration.

The media type now downloads assets from Acquia DAM and keeps them synchronized in your local file system.

Choose between public and private file storage

After you use download and sync, you must decide whether to store files in the public or private file system.

Public file storage

Assets stored in public files:

• Are accessible through direct URLs without Drupal permission checks.
• Provide faster performance because Drupal does not need to bootstrap for each file request.
• Work well with external CDNs and reverse proxies.
• Are suitable for images, videos, and documents intended for general public access.

Private file storage

Assets stored in private files:

• Require Drupal’s permission system for access.
• Enforce access control on each file request.
• Are suitable for confidential documents, restricted media, or member‑only content.
• Have additional performance overhead due to Drupal handling each file request.

Select the option that matches your security and performance requirements before you enable Download and sync assets for a media type.

Download assets to local storage

After you enable download and sync on a media type, assets can be downloaded to local storage in several ways.

Through the user interface (manual)

To trigger a manual download for a specific media type:

1. In the administrative menu, select Structure.
2. Select Media types, then select Edit for your media type.

3. In the Acquia DAM configuration section, select the Download and sync assets button.

   

4. Monitor the batch progress as the system downloads and processes assets.

   
5. Review the completion summary showing downloaded files and any errors.

Through Command-Line Interface (Drush)

Run the download command to process assets for a specific media type:

drush acquia-dam:download-assets <media-type-id> [--redownload]

Options:

• <media-type-id>: The machine name of the media type to download.
• --redownload: Force a re-download of all assets for that media type, even if local files already exist.

Examples:

drush acquia-dam:download-assets acquia_dam_video_asset
drush acquia-dam:download-assets acquia_dam_video_asset --redownload

Embed codes serve assets directly from Acquia DAM’s CDN. This method does not store files locally in Drupal and relies on Acquia DAM for file delivery.

How embed render works

After you use the embed codes:

• Assets remain in Acquia DAM.
• Drupal stores only asset metadata and references.
• Visitors receive assets through iframes or direct CDN URLs.
• The Acquia DAM CDN handles all file delivery.
• Assets use the latest available version from Acquia DAM that the integration detects during sync.

Configure a media type for embed render

To configure a media type to use embed render:

1. In the administrative menu, select Structure.
2. Select Media types to access all media types.
3. Locate a media type that uses the Acquia DAM media source, then select Edit.

4. In the Media source configuration section, ensure that the Download and sync assets checkbox is empty.

   
5. Select Save to store the configuration.

The media type now serves assets with embed codes from the Acquia DAM CDN.

Configure embed code display

To configure the display of embed‑based assets:

1. In the administrative menu, select Structure.
2. Select Media types, then select Manage display for your media type.
3. Locate the Asset reference field.
4. In the Format column, select Embed code.
5. Select the gear icon to configure embed options.
6. In the Embed style list, select your preferred rendering option.
7. Configure additional options such as thumbnail width.
8. Select Update, then select Save to store the display configuration.

Configure download and sync

Download and sync store asset files locally in your Drupal file system. This method downloads files from Acquia DAM and keeps them synchronized after assets update.

How download and sync work

After you enable download and synchronization on a media type:

1. Assets are downloaded from Acquia DAM to your Drupal file system.
2. Files are stored in either public or private file directories.
3. Drupal serves assets directly from the local file system.
4. After an asset update in Acquia DAM, updated files are re-downloaded during cron runs or through manual/Drush triggers.
5. You have full control over file access through Drupal’s file and permission system.

When to use download and sync

Use this method to:

• Control access to assets with the permission or role system of Drupal.

• Serve files through public or private file systems of Drupal rather than directly from the Acquia DAM CDN.

• Integrate with file management and private file handling of Drupal.

Configure a media type for download and sync

To enable download and synchronization on a media type:

1. In the administrative menu, select Structure.
2. Select Media types to view all media types.
3. Locate a media type using the Acquia DAM source, then select Edit.
4. In the Media source configuration section, check the Download and sync assets checkbox.
5. In the Upload destination section, select a file storage option:
   • Public files: Assets are accessible through direct URLs and do not require Drupal access checks.
   • Private files: Assets are served through Drupal with access checks, respecting Drupal’s permission system.

6. To restrict which file extensions are downloaded, enter them in the Allowed file extensions field. Leave this field empty to permit all extensions.

   
7. Select Save to store the configuration.

The media type now downloads assets from Acquia DAM and keeps them synchronized in your local file system.

Choose between public and private file storage

After you use download and sync, you must decide whether to store files in the public or private file system.

Public file storage

Assets stored in public files:

• Are accessible through direct URLs without Drupal permission checks.
• Provide faster performance because Drupal does not need to bootstrap for each file request.
• Work well with external CDNs and reverse proxies.
• Are suitable for images, videos, and documents intended for general public access.

Private file storage

Assets stored in private files:

• Require Drupal’s permission system for access.
• Enforce access control on each file request.
• Are suitable for confidential documents, restricted media, or member‑only content.
• Have additional performance overhead due to Drupal handling each file request.

Select the option that matches your security and performance requirements before you enable Download and sync assets for a media type.

Download assets to local storage

After you enable download and sync on a media type, assets can be downloaded to local storage in several ways.

Through the user interface (manual)

To trigger a manual download for a specific media type:

1. In the administrative menu, select Structure.
2. Select Media types, then select Edit for your media type.

3. In the Acquia DAM configuration section, select the Download and sync assets button.

   

4. Monitor the batch progress as the system downloads and processes assets.

   
5. Review the completion summary showing downloaded files and any errors.

Through Command-Line Interface (Drush)

Run the download command to process assets for a specific media type:

Options:

• <media-type-id>: The machine name of the media type to download.
• --redownload: Force a re-download of all assets for that media type, even if local files already exist.

Examples: