README

This skeleton should be used by experienced Pimcore developers for starting a new project from the ground up. If you are new to Pimcore, it's better to start with our demo package, listed below 😉

Getting started

COMPOSER_MEMORY_LIMIT=-1 composer create-project pimcore/skeleton my-project
cd ./my-project
./vendor/bin/pimcore-install

Point your virtual host to my-project/public
Open https://your-host/admin in your browser
Done! 😎

Docker

You can also use Docker to set up a new Pimcore Installation. You don't need to have a PHP environment with composer installed.

Prerequisits

Your user must be allowed to run docker commands (directly or via sudo).
You must have docker-compose installed.
Your user must be allowed to change file permissions (directly or via sudo).

Follow these steps

Initialize the skeleton project using the pimcore/pimcore image docker run -u `id -u`:`id -g` --rm -v `pwd`:/var/www/html pimcore/pimcore:php8.1-latest composer create-project pimcore/skeleton my-project
Go to your new project cd my-project/
Part of the new project is a docker compose file
- Run echo `id -u`:`id -g` to retrieve your local user and group id
- Open the docker-compose.yaml file in an editor, uncomment all the user: '1000:1000' lines and update the ids if necessary
- Start the needed services with docker-compose up -d
Install pimcore and initialize the DB docker-compose exec php vendor/bin/pimcore-install --mysql-host-socket=db --mysql-username=pimcore --mysql-password=pimcore --mysql-database=pimcore
- When asked for admin user and password: Choose freely
- This can take a while, up to 20 minutes
✔️ DONE - You can now visit your pimcore instance:
- The frontend: http://localhost
- The admin interface, using the credentials you have chosen above: http://localhost/admin

Other demo/skeleton packages

Pimcore Basic Demo

pimcore / skeleton

Maintainers

Details