Headless Bundle
Release Plan
| Release | Supported OpenDXP Versions | Supported Symfony Versions | Release Date | Maintained | Branch |
|---|---|---|---|---|---|
| 1.x | ^1.0 | ^7.4 | 2025 | Feature Branch | 1.x |
Installation
"require": {
"open-dxp/headless-bundle": "^1.2",
}
Add Bundle to bundles.php:
return [
# add to bottom
OpenDxp\Bundle\HeadlessBundle\HeadlessBundle::class => ['all' => true],
];
Add required configuration:
opendxp_headless:
opensearch:
hosts:
- localhost:9200 # replace with your opensearch
credentials: []
- Execute:
$ bin/console doctrine:migrations:migrate --prefix 'OpenDxp\Bundle\HeadlessBundle\Migrations'
Dependencies
- nelmio/api-doc-bundle
- lexik/jwt-authentication-bundle
- gesdinet/jwt-refresh-token-bundle
- w3r-one/json-schema-bundle
Supported Bundles (but not required)
- open-dxp/seo-bundle (Highly Recommended)
- open-dxp/i18n-bundle (Highly Recommended)
- open-dxp/dynamic-search-bundle (Recommended)
- open-dxp/dynamic-search-data-provider-trinity-bundle
- open-dxp/dynamic-search-index-provider-opensearch-bundle
- open-dxp/formbuilder-bundle
Using OpenDxp in hybrid mode
If you want to use this bundle with a default (classic) OpenDxp installation, please note the following limitations:
- The headless-toolbox bundle is not supported
- If you're using formbuilder-bundle, ensure the brick is re-enabled
[!IMPORTANT] Before starting with implementation, read the Concepts section carefully. It explains how site-based host configuration works, including General Domain resolution, per-site Asset Base URI, and Flush Frontend Cache setup.
Next Steps
- Setup/System Configuration
- Authentication & Certification (JWT)
- Backend Logging
- Configuration
- Routing
- API Routes for Data Objects (
data_object_api_routes) - Response Entity Mapping (
response_entity_mapping) - API Filter (
available_filter) - API Validation / Serialization
- API Forms (
api_forms) - API Cache Flush (
api_flush_cache_trigger) - Email Configuration (
email_template_paths) - Thumbnail Definitions (
thumbnail_definitions) - CORS Configuration (
cors)
- API Documentation
- Navigation Enhancement
Changelog
Before updating, please check the changelog!
License
DACHCOM.DIGITAL AG, Löwenhofstrasse 15, 9424 Rheineck, Schweiz
dachcom.com, [email protected]
Copyright © 2026 DACHCOM.DIGITAL. All rights reserved.
For licensing details please visit LICENSE.md