Skip to main content
Version: 2026.2

Installation

info

This bundle requires Pimcore Core Framework 12 / 2026.x, Studio Backend Bundle, and Studio UI Bundle. Install those first.

Bundle Installation​

  1. Install the required dependencies:
composer require pimcore/studio-dashboards-bundle
  1. Enable the bundle in config/bundles.php:
use Pimcore\Bundle\StudioDashboardsBundle\PimcoreStudioDashboardsBundle;
// ...
return [
// ...
PimcoreStudioDashboardsBundle::class => ['all' => true],
// ...
];
  1. Run the bundle installer to register the required user permissions:
bin/console pimcore:bundle:install PimcoreStudioDashboardsBundle
  1. Clear the cache:
bin/console cache:clear

Permissions​

The installer registers the following user permissions in the Pimcore Studio Dashboards Bundle category:

PermissionDescription
studio_dashboards_viewView dashboards
studio_dashboards_editCreate and edit own dashboards
studio_dashboards_edit_allEdit dashboards owned by other users
studio_dashboards_shareShare dashboards with other users or globally
studio_dashboards_exportExport dashboards as ZIP archives
studio_dashboards_importImport dashboard ZIP archives

Assign these permissions to roles or users in Pimcore Studio under Settings > Users & Roles.

The navigation entry Reporting > Dashboards is also controlled by the reporting.dashboards perspective permission (configured under Settings > Perspectives in Pimcore Studio). Enable it for any perspective that should show the dashboards menu.

Frontend Build​

The compiled Studio frontend ships as a single archive (build-dist/build-<id>.zip) rather than a committed public/studio/build/ directory. pimcore/studio-ui-bundle extracts it into public/studio/build/ automatically during cache warmup, so no extra step is needed for a standard installation.

caution

Read-only filesystem deployments must run bin/console cache:warmup (or cache:clear) during the build/deploy phase, while the bundle directory (usually under vendor/) is still writable. When assets:install runs in copy mode, run cache:warmup before it, otherwise no frontend assets are copied. If the filesystem becomes read-only before the first warmup, the bundle fails with BuildArchiveNotWritableException because there is no build to serve.