Edit on GitHub

Pimcore Installation

The following guide assumes your're using a typical LAMP environment, if you're using a different setup (eg. Nginx) or 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 (please remember project root != document root):

cd /your/project

Choose a package to install

We're offering 4 different installation packages, 3 demo packages and one skeleton for experienced developers.

1. Skeleton Package (only for experienced Pimcore developers)
COMPOSER_MEMORY_LIMIT=3G composer create-project pimcore/skeleton my-project
2. Basic Demo Package (PHP Templates)
COMPOSER_MEMORY_LIMIT=3G composer create-project pimcore/demo-basic my-project
3. Basic Demo Package (Twig Templates)
COMPOSER_MEMORY_LIMIT=3G composer create-project pimcore/demo-basic-twig my-project
4. Advanced Demo Package (E-Commerce, PIM, MDM, DAM, ...)
COMPOSER_MEMORY_LIMIT=-1 composer create-project pimcore/demo-ecommerce my-project

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

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

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.

Note: 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/installer/logs 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

*/5 * * * * /your/project/bin/console maintenance

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).

6. Additional Information & Help

If you would like to know more about 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