Skip to main content
Version: 2024.4

Installation

Minimum Requirements​

  • Pimcore >= 10.2
  • Pimcore Datahub >= 1.0

Please note that the Datahub bundle needs to be installed first.

Installation Process​

For Pimcore >= 10.5​

To install Pimcore Headless Documents for Pimcore 10.5 or higher, follow the three steps below:

  1. Install the required dependencies:
composer require pimcore/headless-documents
  1. Make sure the bundle is enabled in the config/bundles.php file. The following lines should be added:
use Pimcore\Bundle\HeadlessDocumentsBundle\PimcoreHeadlessDocumentsBundle;
// ...

return [
    // ...
    // make sure PimcoreDataHubBundle is added before to that list
    // ...
    PimcoreHeadlessDocumentsBundle::class => ['all' => true],
    // ...
];
  1. Install the bundle:
bin/console pimcore:bundle:install PimcoreHeadlessDocumentsBundle

For Older Versions​

To install the Headless Documents bundle for older versions of Pimcore, please run the following commands instead:

composer require pimcore/headless-documents
bin/console pimcore:bundle:enable PimcoreHeadlessDocumentsBundle
bin/console pimcore:bundle:install PimcoreHeadlessDocumentsBundle

Check if the bundle has been installed:

php bin/console pimcore:bundle:list
+---------------------------------+---------+-----------+----+-----+-----+
| Bundle                          | Enabled | Installed | I? | UI? | UP? |
+---------------------------------+---------+-----------+----+-----+-----+
| PimcoreHeadlessDocumentsBundle  | ✔       | ✔        | ❌  | ✔  | ❌ |
+---------------------------------+---------+-----------+----+-----+-----+

Required Backend User Permission​

To create or modify Headless Document templates & bricks configuration, user needs to meet one of following criteria:

  • be an admin
  • have pimcore_headless_documents_config permission