Contact us

Installation

By Mario Prša · Updated 19 Nov 2026

A developer installs the Pimcore InDesign bundle in the Pimcore project, then sends the InDesign plugin installation ZIP from the package to each person who will use the plugin (for example, a designer or product manager). That person installs the plugin on their own InDesign workstation. The developer needs access to the Pimcore project and server/deployment environment, the bundle package, and a code editor (for example, Visual Studio Code).

Install Pimcore InDesign bundle

Run these six steps in the Pimcore project environment.

1. Add the GitLab repository to Composer. The bundle is hosted on GitLab rather than Packagist. Add this entry to the project’s composer.json under repositories (merge it with any existing entries rather than replacing them):

{
  "repositories": {
    "factory-indesign-bundle": {
      "type": "git",
      "url": "https://oauth2:<ACCESS-TOKEN>@git.byfactory.dev/factory/indesign-bundle.git"
    }
  }
}

Replace <ACCESS-TOKEN> with an authorized GitLab access token. Keep it secret; do not include a real token in screenshots or published documentation. Follow your project’s credential-handling practice.

2. Install the bundle via Composer in the Pimcore project:

composer require factory/indesign-bundle:^1.2

3. Register the bundle if needed. It should register automatically in config/bundles.php. If it does not, add this entry to the existing returned array:

<?php
// config/bundles.php
return [
    // ...existing bundles
    Factory\InDesignBundle\InDesignBundle::class => ['all' => true],
];

4. Install the bundle:

bin/console pimcore:bundle:install InDesignBundle

5. Install bundle resources so public JavaScript files are available in Pimcore Admin:

bin/console assets:install --symlink

The --symlink option creates symbolic links instead of copying files.

6. Clear Symfony and Pimcore caches:

bin/console cache:clear
bin/console pimcore:cache:clear

After completing all six steps, the developer finds the InDesign plugin installation ZIP in the package and sends that ZIP to each person who will use the plugin in their work (for example, a designer or product manager).

Install Factory InDesign plugin

On their InDesign workstation, the person who will use the plugin:

1. Extracts the ZIP received from the developer and locates the .ccx plugin installation file in the extracted files.

2. Double-clicks the .ccx file to install the Factory InDesign plugin through Adobe Creative Cloud.

Before starting Using plugin, wait until Datahub configuration, Create image thumbnail for InDesign plugin, and Licence validation have all been completed. Obtain the GraphQL Endpoint URL, API Key, and Product Key from the person managing the Pimcore connection.