Skip to main content
Version: Next

Pimcore PaaS

What is Pimcore PaaS and how does it work?​

Pimcore Platform-as-a-Service is a cloud platform for building, running and scaling your Pimcore applications, provided by the top-notch Platform.sh technology stack. It also includes the license for Pimcore Enterprise Edition and therefore opens up all the possibilities of the extensive features and services.

For a more detailed overview of features, pricing and ordering, please visit our product page.

Getting Started​

First of all it's important to make yourself familiar with the concept of Platform.sh. Since there are no major differences between Pimcore PaaS and Platform.sh, there's only the following short on-top documentation to the Platform.sh docs, which outlines the specifics of how to run Pimcore on Platform.sh.

Preparation Work​

❗ You need a Pimcore license token and your custom Composer repository URL, both you can find on the license certificate.

❗ If you're starting a new project, just follow the general setup instructions for our skeleton or demo projects to setup a local instance of your project.

❗ If you are migrating from already existing project check out our migration guide

Once you have your project up and running locally or if you're having an existing project, you can continue with the following steps to setup PaaS.

Project Setup​

Run the following commands to enable the Pimcore Commercial License and install the Pimcore PaaS tools package to your project. Don't forget to replace YOUR_PIMCORE_TOKEN and YOUR_REPO_NAME with the actual values.

composer config --auth http-basic.repo.pimcore.com token YOUR_PIMCORE_TOKEN
composer config repositories.pimcore_enterprise composer https://repo.pimcore.com/YOUR_REPO_NAME/
composer require pimcore/paas

Now enable the Enterprise Subscription Tools bundle in your /config/bundles.php, by adding this line:

    \Pimcore\Bundle\EnterpriseSubscriptionToolsBundle\PimcoreEnterpriseSubscriptionToolsBundle::class => ['all' => true],

Project configuration​

It's now time to install the PaaS specific configuration files to your project, by running

./vendor/bin/pimcore-paas-install-config

The last command will install a bunch of configuration files into your project's directory:

  • .platform/* PaaS infrastructure configuration
  • .platform-scripts/* deploy and build scripts
  • config/pimcore/startup.php dynamic service configuration mapping
  • config/platform.yaml Pimcore generic PaaS configuration
  • .env.(dev|prod) example config for your different environments

Please commit all of those files to your Git repository. All of this configurations can be freely customized.

Project product registration​

After you have customised your config, if you are using Pimcore Platform version above 2025.1 you need to register your Pimcore project instance by running the command below.

If you have already registered your product, you can skip the step below and go straight to the project setup in console.

The command will also generate needed params for the Pimcore product registration. Follow the URL for the registration.

./vendor/bin/pimcore-paas-product-registration

Project Setup in Console​

Please log in to the console.

  1. Create a new project in the Console

  2. Go to Settings -> Variables and create the following new variables:

    • env:APP_ENV with the value of your APP_ENV dev or prod
    • env:PIMCORE_TOKEN with the license token as the value (e.g. a67ca3fa22e809a1781e15678013bb8...)
    • env:PIMCORE_INSTALL_ADMIN_USERNAME with username for your admin account (e.g. administrator) (tick sensitive option)
    • env:PIMCORE_INSTALL_ADMIN_PASSWORD with the password for your admin account (tick sensitive option)
    • env:PIMCORE_INSTALL_PRODUCT_KEY with the Product Key from the product registration page
    • env:PIMCORE_INSTALL_INSTANCE_IDENTIFIER with the Instance Identifier from the product registration page
    • env:PIMCORE_INSTALL_ENCRYPTION_SECRET with the Encryption Secret generated in the previous step

  3. Follow the setup instructions in the user interface. If the instructions are not already shown by default, please press the "Finish setup".

You should now have a running Pimcore instance on PaaS.

Next Steps & further Information​