Pimcore compose environment
Dockerwest Compose Environment for Pimcore.
For detailed documentation, visit our website
When using Pimcore 5, please use the "pimcore5" branch!
For your convenience the developer environment has some helpers which take away some difficulties you could experience using docker containers.
If you want this easy helpers to be readily available for you you can use
environment before you start.
environment allows you to start your
environment with an updated
PATH and allows you to choose between
byobu. You can also define a default in the .env file.
explicit setting the window manager:
$ ./environment [tmux|screen|byobu]
using default window manager, defined in .env
When you are running in this environment all helpers are available in your path.
You are not required to use the environent, but then you have to call the helpers with their full path.
To make use of the helpers you should use the
run wrapper for
$ run up
There is a sample configuration
.env-sample which contains the defaults used
in this environment.
If you want to change some of these values, copy
C_UID=1000 C_GID=1000 PHPVERSION=7.1 NGINXVERSION=stable PIMCOREVERSION=5 BASEHOST=pimcore.docker MYSQL_ROOT_PASSWORD=toor APPLICATION=../pimcore DEVELOPMENT=1 WINDOW_MANAGER=tmux
C_UID / C_GID
Configure what UID and GID your PHP container must use. This usually should
match your Hosts UID and GID. To find your local UID you can run
id -u and to
find your local GID you can run
Choose your PHP version. To see which versions are available here.
Choose what version of Nginx you want. To see which versions are available see here
Choose the version of pimcore you are going to use. The nginx configuration is slightly different between version 4 and version 5.
This setting defines what the hostname will be you can browse your pimcore app.
The example configuration will be give you
Choose whatever you want to use as default root password.
A relative or absolute path to your pimcore code. this can be a checkout of pimcore.
There is the
DEVELOPMENT environment variable wich will enable xdebug,
composer and enable timestamp checking in opcache.
DEVELOPMENT is enabled xdebug should work out of the box. When you have
issues - like while running docker for mac - you can set the extra environment
XDEBUG_CONFIG with your hosts ip in it so xdebug can properly
Set the default window manager when running the environment. Available options are: tmux, screen and byobu
The helpers are written in python, so you should have python2 or python3 installed on your system to be able to use them. Most Linux distributions and macOS have python already installed so there should be no issue there. There are no extra dependencies on python modules.
For detailed information on helpers, see our website
This will run the pimcore installation create a default admin login user. The
admin user is
admin and the password is
DockerWest123!. The admin endpoint
will be found under
MIT License (MIT). See License File for more information.