Skip to main content
Version: Next

Webserver Installation

The following guide assumes you're using a typical LAMP environment. If you're using a different setup (eg. Nginx) or you're facing a problem, please visit the Installation Guide section.

1. System Requirements​

Please have a look at System Requirements and ensure your system is ready for Pimcore.

2. Install Pimcore & Dependencies​

The easiest way to install Pimcore is from your terminal using Composer. Change into the root folder of your project:

cd /your/project
caution

Please remember: project root != document root

Choose a Package to Install​

We offer 2 different installation packages:

  • a demo package with exemplary blueprints.
  • an empty skeleton package for experienced developers.
1. Skeleton Package (only for experienced Pimcore developers)​
COMPOSER_MEMORY_LIMIT=-1 composer create-project pimcore/skeleton my-project
Demo Package​
COMPOSER_MEMORY_LIMIT=-1 composer create-project pimcore/demo my-project

Point the document root of your vhost to the newly created /public folder (eg. /your/project/public). Keep in mind that Pimcore needs to be installed outside of the document root. Specific configurations and optimizations for your web server are available here: Apache, Nginx

Pimcore requires write access to the following directories (relative to your project root): /var, /public/var (Details)

If you're running the installation using a custom environment name, ensure you already have the right config files in place, e.g. config/packages/[env_name]/config.yaml.

3. Create Database​

mysql -u root -p -e "CREATE DATABASE project_database charset=utf8mb4;"

For further information please visit out DB Setup Guide

4. Launch Installer​

cd ./my-project
./vendor/bin/pimcore-install

This launches the interactive installer with a few questions. Make sure that you set the memory_limit to at least 512M in your php.ini file.

info

Pimcore allows a fully automated installation process. Read more here: Advanced Installation Topics

Open Admin Interface​

After the installer has finished, you can open the admin interface: https://your-host.com/admin

Debugging Installation Issues​

The installer writes a log in var/log which contains any errors encountered during the installation. Please have a look at the logs as a starting point when debugging installation issues.

5. Maintenance Cron Job​

Maintenance tasks are handled with Symfony Messenger. The pimcore:maintenance command will add the maintenance messages to the bus. However, pimcore:maintenance will not process the maintenance messages itself. Independent workers are required to consume these messages from the queues and perform maintenance tasks. In a typical Pimcore installation, you should set up workers for these transports:

#Transport namePurpose
1pimcore_coreCore background tasks such as converting videos, rendering Asset previews, etc.
2pimcore_maintenanceMaintenance tasks
3pimcore_scheduled_tasksScheduled tasks
4pimcore_image_optimizeExecute optimizers on Asset image thumbnails
5pimcore_asset_updateProcess Asset metadata e.g. Documents page count, Video duration/dimensions, Image previews etc.
6pimcore_search_backend_messageUpdate the index for Pimcore backend search. Only if you install SimpleBackendSearchBundle

Beware that the actual transports depend on which core bundles you installed. Therefore, you will need to adjust the list accordingly to your installation. Use bin/console debug:messenger to list all available transports.

Consuming messages from the queues is performed with the messenger:consume command (e.g., bin/console messenger:consume pimcore_core ...). You might need to spawn multiple workers, each consuming from a different queue to avoid blocking message processing by long-running tasks. For example:

bin/console messenger:consume pimcore_core pimcore_maintenance pimcore_scheduled_tasks pimcore_search_backend_message pimcore_asset_update
bin/console messenger:consume pimcore_image_optimize

We recommend following the Symfony Messenger guide for setting up worker processes in production. The following is a simplified example of maintenance tasks execution using cron:

# this command needs to be executed via cron or similar task scheduler
# it fills the message queue with the necessary tasks, which are then processed by messenger:consume
*/5 * * * * /your/project/bin/console pimcore:maintenance

# it's recommended to run the following command using a process control system like Supervisor
# please follow the Symfony Messenger guide for a best practice production setup: 
# https://symfony.com/doc/current/messenger.html#deploying-to-production
*/5 * * * * /your/project/bin/console messenger:consume pimcore_core pimcore_maintenance pimcore_scheduled_tasks pimcore_search_backend_message --time-limit=300
*/5 * * * * /your/project/bin/console messenger:consume pimcore_asset_update --time-limit=300
*/5 * * * * /your/project/bin/console messenger:consume pimcore_image_optimize --time-limit=300

Refer to Symfony Messenger for further information on working with the messenger component in Pimcore.

Depending on installed and activated extensions, it might be necessary to add additional transports to the messenger consume command. Please look at the documentation of corresponding extensions for more details.

Keep in mind that the cron job has to run as the same user as the web interface to avoid permission issues (eg. www-data).

For information about how to handle failed jobs, see this section.

Caching​

Make sure to use any sort of caching to improve performance. We recommend Redis cache storage.

6. Additional Information & Help​

If you would like to know more about the installation process or if you are having problems getting Pimcore up and running, visit the Installation Guide section.

7. Further Reading​

Next up - Directories Structure