Skip to main content
Version: 2024.4

Installation of Pimcore Copilot

Installation​

To install the Pimcore Copilot bundle, follow the three steps below:

  1. Install the required dependencies:
composer require pimcore/copilot-bundle
  1. Make sure the bundle is enabled in the config/bundles.php file. The following lines should be added:
use Pimcore\Bundle\CopilotBundle\PimcoreCopilotBundle;
// ...
return [
    // ...
    PimcoreCopilotBundle::class => ['all' => true],
    // ...
];
  1. Install the bundle:
bin/console pimcore:bundle:install PimcoreCopilotBundle
  1. Schedule the cronjob for the Pimcore Copilot bundle: To set up the cronjob, add the following line to your crontab. This will check for scheduled actions every minute and execute them if necessary.
* * * * * php /home/project/www/bin/console copilot:automation-action:scheduled-actions
  1. [Optional] Setting environment variables:

If you intend to use the OpenAI or Hugging Face actions, you need to set the respective environment variables:

  • OpenAI API key: To use the OpenAI API Actions, you need to set the environment variable OPEN_AI_AUTH_TOKEN
  • Hugging Face API key: To use the Hugging Face API Actions, set the environment variable HUGGING_FACE_AUTH_TOKEN
info

There is a collection of additional actions for showcasing Pimcore Copilot. To install them, install the bundle composer require pimcore/copilot-showcase-bundle and activate it in config/bundles.php.

Bundle Configuration​

The execution of automated actions is based on the Symfony Messenger queue. If activated, the selected automated actions are automatically executed.

Messages are dispatched via pimcore_job_execution_engine transport. Please ensure you have workers processing this transport when using automated actions.