Akamai Setup for hlx.live
NOTE: The instructions linked on this page apply to the previous version of Edge Delivery Services and are provided for customers who have not upgraded to aem.live yet. The current version of this document is provided here.
The following screenshots illustrate how to use the Akamai Property Manager to configure a property to deliver content from AEM using your Akamai CDN setup. Essential settings are marked with a red circle.
Essential Property settings
Origin Server
Configuration properties:
| Name | Value | Comment |
Origin Server Hostname |
main--<repo>--<organization>.hlx.live |
Replace repo and organization with the values for your site. |
Forward Host Header |
Origin Hostname |
|
Cache Key Hostname |
Incoming Host Header |
Add Behavior: Remove Vary Header
Configuration properties:
| Name | Value | Comment |
Remove Vary Header |
On |
Add Behavior: Modify Outgoing Request Header
Configuration properties:
| Name | Value | Comment |
Action |
Modify |
|
Custom Header Name |
X-Forwarded-Host |
|
New Header Value |
{{builtin.AK_HOST}} |
|
Avoid Duplicate Headers |
Yes |
Add more outgoing request headers:
Configuration properties:
| Name | Value | Comment |
Action |
Modify |
|
Custom Header Name |
X-BYO-CDN-Type |
|
New Header Value |
akamai |
|
Avoid Duplicate Headers |
Yes |
Configuration properties:
| Name | Value | Comment |
Action |
Modify |
|
Custom Header Name |
X-Push-Invalidation |
|
New Header Value |
enabled |
|
Avoid Duplicate Headers |
Yes |
Add/Modify Behavior: Caching
Configuration properties:
| Name | Value | Comment |
Caching Option |
Honor origin Cache-Control |
|
Enhanced RFC support |
No |
|
Honor private |
No |
|
Honor must-revalidate |
No |
Add Behavior: HTTP/2
(Optional, but recommended)
Add Rule: Modify Outgoing Response Header
Create a new rule
Set the criteria for the rule to be applied
Set the behavior if a match is found
These are all essential property settings for delivering content.
Caveats
Do not enable Akamai mPulse Real Usage Monitoring. While the performance impact on most sites is negligible, for sites built for consistent high performance, enabling it will prevent reaching a Lighthouse Score of 100. In AEM, you have a Real User Monitoring service built-in, so that dual instrumentation will be unnecessary and is strongly discouraged.
Also, do not enable Akamai Bot Manager or similar Web Application Firewall offerings, as they markedly interfere with rendering performance and user experience. Your site on AEM is protected against bot attacks on the backend, so that this performance cost comes with negligible benefit.
Previous