Skip to main content

Installation

Requirements​

Organizational Requirements​

  • Credentials for Private Composer Packagist (from twocream)
  • DeepL API key (Free or Pro): The DeepL API key is required to use the bundle.

Technical Dependencies​

Required Pimcore Bundles​

The bundle requires the following additional Pimcore bundles:

Composer Dependencies​

The following third-party packages are also needed:

  • twocream/pimcore-core-bundle
  • deeplcom/deepl-php

Installation Guide​

1. Add Composer Repository​

Add the twocream Composer repository, e.g., in the file composer.json of your Pimcore installation:

{
  "config": {
    "http-basic": {
      "twocream.repo.packagist.com": {
        "username": "{CUSTOMER_ID}",
        "password": "{CUSTOMER_SECRET}"
      }
    }
  },
  "repositories": [{
    "type": "composer",
    "url": "https://twocream.repo.packagist.com/{CUSTOMER_ID}/"
  }]
}
Note

Replace {CUSTOMER_ID} and {CUSTOMER_SECRET} with the provided license information.

2. Install the Bundle​

Run the following command to install the bundle via Composer:

composer require twocream/pimcore-deepl-bundle

3. Register the Bundle​

Add to the file config/bundles.php to activate the bundle:

<?php

return [
    // ...
    \Twocream\DeepLBundle\TwocreamDeepLBundle::class => ['all' => true],
    // ...
];

4. Install the Bundle​

Install the bundle with the following command:

php bin/console pimcore:bundle:install TwocreamDeepLBundle

5. Perform Migrations​

Check and execute all necessary database migrations:

php bin/console doctrine:migrations:migrate

6. Configuration in Admin Area​

After installation, you will find the bundle's configuration options in the Pimcore admin area under Twocream Bundle Configuration.

*/5 * * * * php bin/console messenger:consume twocream_deepl_object_translation --time-limit=300

Additional Notes​

Further Documentation​

If you have questions or issues during installation, feel free to contact us!: