update documentation reflecting that remote assets are no longer enab…

…led by default
wcm-io · Aug 23, 2024 · eacebbf · eacebbf
1 parent 932a0dc
commit eacebbf
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 8 deletions.
diff --git a/changes.xml b/changes.xml
@@ -23,16 +23,17 @@
     xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd">
   <body>
 
-    <release version="2.1.2" date="not released">
-      <action type="add" dev="sseifert" issue="61">
+    <release version="2.2.0" date="not released">
+      <action type="update" dev="sseifert" issue="61">
         Dynamic Media with OpenAPI: Use static cropping (center cropping) if named smart cropping based on Image Profile define in AEM is not available.
       </action>
-      <action type="add" dev="sseifert" issue="61">
+      <action type="update" dev="sseifert" issue="61">
         Dynamic Media with OpenAPI: Provide max. width/height in UriTemplate if source image dimension is available in metadata.
       </action>
-      <action type="update" dev="sseifert" issue="64">
-        Dynamic Media with OpenAPI: Do not enable support for remote assets by default. Since general availability the related configuration services not longer protected by a feature flag, so the feature has to be enabled explicitly via OSGi configuration.
-      </action>
+      <action type="update" dev="sseifert" issue="64"><![CDATA[
+        Dynamic Media with OpenAPI: Do not enable support for remote assets by default. Since general availability the related configuration services not longer protected by a feature flag, so the feature has to be enabled explicitly via OSGi configuration.<br/>
+        <b>Breaking change:</b> You can enable support for remote assets by setting "Remote Assets" to true in the "wcm.io Media Handler Dynamic Media with OpenAPI Support" OSGi configuration.
+      ]]></action>
       <action type="update" dev="sseifert">
         Eliminate dependency to Commons Lang 2.
       </action>

diff --git a/src/site/markdown/dynamic-media-openapi.md b/src/site/markdown/dynamic-media-openapi.md
@@ -82,9 +82,19 @@ public class MediaHandlerConfigImpl extends MediaHandlerConfig {
 }
 ```
 
-With this configuration, remote assets should work out-of-the-box, if a remote asset repository is configured for the AEMaaCS instance.
+By default, support for local and remote assets is disabled, because it depends on separate licensing for an AEMaaCS environment. For using remove assets, additional configuration (environment variables) are required to configure the remote repository, see AEM documentation.
 
-The "wcm.io Dynamic Media with OpenAPI Support" OSGi configuration allows to reconfigure the actual URLs used for the [Assets Delivery API (DM API)][aem-dm-api]. Usually you can stick with the default values which reflect the latest version of the DM API. Remote assets are supported by default, but can be disabled via this configuration. Local assets are disabled by support, but can be enabled via this configuration. In this case, you also have to configure a repository ID for building the rendition URLs pointing to the AEMaaCS instance. Example:
+The "wcm.io Dynamic Media with OpenAPI Support" OSGi configuration allows to enable the support. Additionally it is possible and to reconfigure the actual URLs used for the [Assets Delivery API (DM API)][aem-dm-api]. Usually you can stick with the default values which reflect the latest version of the DM API.
+
+To enable support for remote Assets configure:
+
+```json
+{
+  "enabledRemoteAssets": true
+}
+```
+
+If you want to enable support for local assets you also have to configure a repository ID for building the rendition URLs pointing to the AEMaaCS instance. Example:
 
 ```json
 {