AEM Config Service
DA recommends that your project uses AEM Config Service for all configurations. At a high level, Config Service allows you to manage:
- Admin, preview, and publish permissions
- Content indexing (aka query-index) and sitemaps
- Robots.txt
- Sidekick configurations and plugins
- Content locations (aka fstab.yaml)
- etc.
This is in addition to allowing "repoless" based projects that allow you to decouple your content location from your code location.
Migrating from file-based to config-based
File-based setups are still technically supported, but will not be prioritized for future improvements. While technically possible, we also recommend that if you move to AEM Config Service, you move completely. You should not have file-based configurations once you perform the upgrade process in AEM Admin Edit.
Below is a helpful guide for migrating each configuration:
Config | File-based location | Config-based location |
Query Index |
(code) |
https://admin.hlx.page/config/{{ORG}}/sites/{{SITE}}/content/query.yaml |
Sitemap |
(code) |
https://admin.hlx.page/config/{{ORG}}/sites/{{SITE}}/content/sitemap.yaml |
Preview & publish permissions |
(content) |
https://admin.hlx.page/config/{{ORG}}/sites/{{SITE}}/access.json |
Robots.txt |
(code) |
https://admin.hlx.page/config/{{ORG}}/sites/{{SITE}}/robots.txt |
Headers |
(content) |
https://admin.hlx.page/config/{{ORG}}/sites/{{SITE}}/headers.json |
Sidekick |
(code) |
https://admin.hlx.page/config/{{ORG}}/sites/{{SITE}}/sidekick.json |
You can see a more comprehensive guide at aem.live.