NOTE: If you are just looking to get easily up and running and developing with eZ Platform, rather look towards eZ Launchpad which is tailored for Project Development use cases. If not, be aware of the following limitations:
WARNING, made mainly for automation: The tools within this directory are meant for use for test automation, QA, Support and demo use cases. And with time as a blueprint for how to best configure your own setup. You are free to use and adopt this for your needs, and we more than welcome contributions to improve it.
WARNING, low performance on MacOS and Windows: For reasons mentioned above, unlike eZ Launchpad these tools are not optimized for use as development environment with Mac or Windows, and are affected by known I/O performance issues caused by Docker for Mac/Windows use of shared folders. This is a know issue and nothing we intend to add complexity to workaround here.
This setup currently requires Docker Compose 1.14 and Docker 17.06 or higher. Defaults are set in .env, and
files to ignore are set in .dockerignore. By default .env specifies that dev setup is used.
NB: For this and other reasons all docker-compose commands must be executed from root of your project directory.
Before jumping into steps below, make sure you have recent versions of Docker & Docker-Compose installed on your machine.
For Windows you'll also need to install bash, or adapt instructions below for Windows command line where needed.
The current Docker Compose files are made to be mixed and matched together for QA/Support use cases. Currently available:
- base-prod.yml (required, always needs to be first, contains: db, web and app container)
- base-dev.yml (alternative to
base-prod.yml, same applies here if used) - blackfire.yml (optional, adds blackfire service and lets you trigger profiling against the setup)
- redis.yml (optional, adds redis service and appends config to app)
- varnish.yml (optional, adds varnish service and appends config to app)
- solr.yml (optional, add solr service and configure app for it)
- selenium.yml (optional, always needs to be last, adds selenium service and appends config to app)
These can be used with -f argument on docker-compose, like:
docker-compose -f doc/docker/base-prod.yml -f doc/docker/redis.yml up -d --force-recreateHowever below environment variable COMPOSE_FILE is used instead since this is also what is used to have a default in
.env file at root of the project.
From root of your projects clone of this distribution, setup composer auth.json and execute the following:
export COMPOSE_FILE=doc/docker/base-prod.yml
# Optional step if you'd like to use blackfire with the setup, change <id> and <token> with your own values
#export COMPOSE_FILE=doc/docker/base-prod.yml:doc/docker/blackfire.yml BLACKFIRE_SERVER_ID=<id> BLACKFIRE_SERVER_TOKEN=<token>
# First time: Install setup, and generate database dump:
docker-compose -f doc/docker/install.yml up --abort-on-container-exit
# Boot up full setup:
docker-compose up -d --force-recreateAfter some 5-10 seconds you should be able to browse the site on localhost:8080 and the backend on localhost:8080/ez.
Warning: Dev setup works a lot faster on Linux then on Windows/Mac where Docker uses virtual machines using shared folders by default under the hood, which leads to much slower IO performance.
From root of your projects clone of this distribution, setup composer auth.json and execute the following:
# Optional: If you use Docker Machine with NFS, you'll need to specify where project is, & give composer a valid directory.
#export COMPOSE_DIR=/data/SOURCES/MYPROJECTS/ezplatform/doc/docker COMPOSER_HOME=/tmp
# First time: Install setup, and generate database dump:
docker-compose -f doc/docker/install.yml up --abort-on-container-exit
# Boot up full setup:
docker-compose up -d --force-recreateAfter some 5-10 seconds you should be able to browse the site on localhost:8080 and the backend on localhost:8080/ez.
Docker-Compose setup for Behat use is provided and used internally to test eZ Platform, this can be combined with most setups, here shown in combination with production setup which is what you1'll typically need to test before pushing your image to Docker Hub/Registry.
From root of your projects clone of this distribution, setup composer auth.json and execute the following:
export COMPOSE_FILE=doc/docker/base-prod.yml:doc/docker/selenium.yml
# First time: Install setup, and generate database dump:
docker-compose -f doc/docker/install.yml up --abort-on-container-exit
# Boot up full setup:
docker-compose up -d --force-recreateLast step is to execute behat scenarios using app container which now has access to web and selenium containers, example:
docker-compose exec --user www-data app sh -c "php /scripts/wait_for_db.php; php bin/behat -vv --profile=rest --suite=fullJson --tags=~@broken"
Tip: You can typically re run the install command to get back to a clean installation in between behat runs using:
docker-compose exec --user www-data app app/console ezplatform:install clean
For composer to run correctly as part of the build process, you'll need to create a auth.json file in your project root with your github readonly token:
echo "{\"github-oauth\":{\"github.com\":\"<readonly-github-token>\"}}" > auth.json
# If you use eZ Enterprise software, also include your updates.ez.no auth token
echo "{\"github-oauth\":{\"github.com\":\"<readonly-github-token>\"},\"http-basic\":{\"updates.ez.no\": {\"username\":\"<installation-key>\",\"password\":\"<token-pasword>\",}}}" > auth.jsonFor further information on tokens for updates.ez.no, see doc.ez.no.
For checking logs from the containers themselves, use docker-compose logs. Here on app service, but can be omitted to get all:
docker-compose logs -t appYou can login to any of the services using docker-compose exec, here shown against app image and using bash:
docker-compose exec app /bin/bashTo display running services:
docker-compose psDatabase dump is placed in doc/docker/entrypoint/mysql/, this folder is used my mysql/mariadb which will execute
everything inside the folder. This means there should only be data represent one install in the folder at any given time.
To updated the used service images, you can run:
docker-compose pull --ignore-pull-failuresThis assumed you either use docker-compose -f or have COMPOSE_FILE defined in cases where you use something else
then defaults in .env.
After this you can re run the production or dev steps to setup containers again with updated images.
Once you are done with your setup, you can stop it, and remove the involved containers.
docker-compose down -vAnd if you have defined any environment variables you can unset them using:
unset COMPOSE_FILE COMPOSE_DIR COMPOSER_HOME
# To unset blackfire variables
unset BLACKFIRE_SERVER_ID BLACKFIRE_SERVER_TOKEN