Enable text compression in AEM

[rajesh_didshe]

How to enable text compression using OSGi config and dispatcher rules for Json file

[EstebanBustamante]

Can you elaborate on what type of compression you are referring to?

I guess you are referring to dispatcher compression, if so, you could use the DEFLATE mod, please take a look at these resources that will guide how to enable this:

https://experienceleague.adobe.com/docs/experience-manager-dispatcher/using/configuring/dispatcher-c...
https://www.albinsblog.com/2018/09/improve-performance-of-adobe-experience.html

[Ravi_Pampana]

Hi,

By default, AEM does not compress JSON files. To enable compression for JSON you can add below in dispatcher.any file

/filter{
/0001
{
/glob "*.json"
/type "allow"
/name "Allow JSON"
/action "gzip"
}
}

After making changes to the Dispatcher configuration, restart the Apache web server to apply the new rules.

[rajesh_didshe]

Hi @Ravi_Pampana ,

can it be applicable for AEM as Cloud Service.

[kautuk_sahni]

@rajesh_didshe Did you find the suggestions from users helpful? Please let us know if more information is required. Otherwise, please mark the answer as correct for posterity. If you have found out solution yourself, please share it with the community.

[rajesh_didshe]

Hi @kautuk_sahni ,

I have tried above both step as @Ravi_Pampana  and @EstebanBustamante mentioned. Tried DEFLATE mod but it's not working and for Filter step getting build failure error on action and name. Have attached Screenshot of build error log for same.

[kautuk_sahni]

To enable text compression using OSGi config and dispatcher rules for JSON files in AEM, you can follow these steps:

1. Enable text compression in AEM.

   • Go to the AEM Configuration Manager.
   • Navigate to OSGi > Configurations > Apache Sling Dispatcher.
   • Edit the filter configuration.
   • Add the following filter rule:
   JSON

   {
       "glob": "*.json",
       "type": "allow",
       "name": "Allow JSON",
       "action": "gzip"
   }
   

   • Save the configuration.

2. Configure the Dispatcher.

   • Edit the dispatcher.any file.
   • Add the following filter rule:
   JSON

   /filter {
       /0001 {
           /glob "*.json"
           /type "allow"
           /name "Allow JSON"
           /action "gzip"
       }
   }
   

   • Save the file.

3. Restart the Dispatcher.

Once you have completed these steps, text compression will be enabled for JSON files in AEM.

Note: If you are using AEM as a Cloud Service, you cannot edit the dispatcher.any file directly. Instead, you must use the Dispatcher configuration UI. To do this, go to the Dispatcher section of the Cloud Manager and click Edit Configuration. Then, add the filter rule.

[kautuk_sahni]

• Configuring Dispatcher | Adobe Experience Manager: https://experienceleague.adobe.com/docs/experience-manager-dispatcher/using/configuring/dispatcher-c... 

[rajesh_didshe]

Hi,

Not able to see Dispatcher section in my Cloud Manager, is there any specific permission required for that.

[Jörg_Hoh]

in AEM CS the dispatcher configuration resides in GIT.

[kautuk_sahni]

To edit your dispatcher configuration in AEM CS, you can either:

1. Clone the Git repository to your local machine and make your changes there. Then, push your changes back to the repository and deploy them to your Dispatcher instances using Cloud Manager.
2. Use the Dispatcher configuration UI in Cloud Manager. This UI provides a graphical interface for editing your dispatcher configuration. However, it does not support all of the features that are available in the dispatcher.any file.

If you need to make changes to your dispatcher configuration that are not supported by the Dispatcher configuration UI, you can edit the dispatcher.any file directly.

[kautuk_sahni]

@rajesh_didshe Were you able to succeed? 

[RajeshDidshe]

 @kautuk_sahni 

dispatcher.any file is immutable, So tried above step in filter.any file but getting build error for action.