EC-CUBE4 environment construction (local edition)

: zipper_mouth: Before

• Docker-compose.yml in the official repository builds Dockerfile at first startup to create a container image. So if you have the EC-CUBE plugin in composer.json, it will (probably) stop at composer install as described in Dockerfile. Therefore, consider how to build an environment without using the official docker-compose.yml.
• Personally, I want PhpStorm's static analysis to work. Therefore, it is better to be able to see the inside of the vendor directory as well, so I built it with this procedure.
• The previously posted article EC-CUBE4 First Deployment has been over a year old and I have forgotten some parts, so I have reorganized it.

: point_right_tone1: Premise

• The version of EC-CUBE that has been confirmed to work is 4.0.5.
• Prepare a suitable docker-compose.yml to proceed with the work. This time, the following sample is assumed.

version: '3'

services:
  web:
    image: xxxx
    container_name: container-web
    working_dir: /var/www/vhosts/your_project/app
    volumes:
      - ../app:/var/www/vhosts/your_project:delegated
      - /var/www/vhosts/your_project/app/codeception
      - /var/www/vhosts/your_project/app/dockerbuild
      - /var/www/vhosts/your_project/app/gulp
      - /var/www/vhosts/your_project/app/node_modules
      - /var/www/vhosts/your_project/app/tests
      - /var/www/vhosts/your_project/app/var/cache
      - /var/www/vhosts/your_project/app/var/log
      - /var/www/vhosts/your_project/app/var/sessions
      - /var/www/vhosts/your_project/app/zap
    ports:
      - '80:80'

• The directory structure of the project is as follows

your_workspace − your_project − docker/docker-compose.yml
　　　　　　　　　　　　　　　　　　∟ app

: raised_hands_tone1: Steps to build a new development environment using Docker

Get the latest source code from GitHub

cd your_workspace/your_project/app
git clone -b 4.0 --depth 1 https://github.com/EC-CUBE/ec-cube.git .

Delete unnecessary files

rm -rf .git

Copying and modifying environment variable files

cp -ap .env.dist .env
vi .env

Start Docker

cd your_workspace/your_project/docker
docker-compose up -d

PHP library installation

docker-compose exec --user apache web composer install --no-scripts --no-autoloader
docker-compose exec --user apache web composer dumpautoload

EC-CUBE setup

#Change permissions and ownership of directories used for cache and log output
docker-compose exec web chown -R apache:apache ./var
docker-compose exec web chmod -R 777 ./var

# EC-CUBE initialization
docker-compose exec --user apache web ./bin/console eccube:install

• About eccube: install, it is internally equivalent to the following.

# (optional)Database deletion
# bin/console doctrine:database:drop --force
#Database creation
# bin/console doctrine:database:create
# (optional)Schema deletion
# bin/console doctrine:schema:drop --force
#Schema generation
# bin/console doctrine:schema:create
#Initial data generation
# bin/console eccube:fixtures:load

EC-CUBE 4.0 Developer Document Site> Installation Method> When Using Windows Environment

Cache generation

docker-compose exec --user apache web ./bin/console cache:warmup

: point_up_tone2: When clearing the cache

docker-compose exec --user apache web ./bin/console cache:clear --no-warmup

Access confirmation

It's OK if you open http: // localhost and see the default shop. : no_entry_sign: The URL depends on the docker image you used.

: raised_hands_tone1: Procedure to build a development environment on another machine using Docker (without EC-CUBE plugin)

Prepare the source code used in the procedure "Procedure for building a new development environment"

Copying and modifying environment variable files

cd your_workspace/your_project/app
cp -ap .env.dist .env
vi .env

Start Docker

cd your_workspace/your_project/docker
docker-compose up -d

PHP library installation

docker-compose exec --user apache web composer install --no-scripts --no-autoloader
docker-compose exec --user apache web composer dumpautoload

EC-CUBE setup

#Change permissions and ownership of directories used for cache and log output
docker-compose exec web chown -R apache:apache ./var
docker-compose exec web chmod -R 777 ./var

# EC-CUBE initialization
docker-compose exec --user apache web ./bin/console eccube:install

Cache generation

docker-compose exec --user apache web ./bin/console cache:warmup

: point_up_tone2: When clearing the cache

docker-compose exec --user apache web ./bin/console cache:clear --no-warmup

Access confirmation

It's OK if you open http: // localhost and see the default shop.

: no_entry_sign: The URL depends on the docker image you used.

: raised_hands_tone1: Procedure to build a development environment on another machine using Docker (with EC-CUBE plugin)

Prepare the source code used in the procedure "Procedure for building a new development environment".

Copying and modifying environment variable files

cd your_workspace/your_project/app
cp -ap .env.dist .env
vi .env

Start Docker

cd your_workspace/your_project/docker
docker-compose up -d

PHP library installation

If you have the EC-CUBE plug-in installed, you can find information about the EC-CUBE plug-in in composer.json and composer.lock. The sales aggregation plugin is ec-cube/SalesReport4. You can't do composer install as it is ...: sob:

To avoid this, prepare the original composer.json and composer.lock of the EC-CUBE version you are using and execute the command.

docker-compose exec --user apache -e COMPOSER=composer_4.0.5.json web composer install --no-scripts --no-autoloader
docker-compose exec --user apache web composer dumpautoload

• Use the environment variable COMPOSER to execute the command by specifying the JSON file. In the above case, the file name of the lock file is composer_4.0.5.lock.

EC-CUBE setup

#Change permissions and ownership of directories used for cache and log output
docker-compose exec web chown -R apache:apache ./var
docker-compose exec web chmod -R 777 ./var

# EC-CUBE initialization
docker-compose exec --user apache web ./bin/console eccube:install

Set authentication key

In my case, the authentication key is prepared for each case (development environment, staging environment, production environment are the same), so set the authentication key obtained in the environment installed first here.

update dtb_base_info set authentication_key='your_authentication_key';

Installation of EC-CUBE plug-in

docker-compose exec --user apache web ./bin/console eccube:composer:install

There is also another command, ./bin/console eccube: composer: require-already-installed. Since it is require, there is a possibility that a version different from composer.lock will be included, so I did not use it here. eccube: composer: install does not refer to the dtb_plugin table, and eccube: composer: require-already-installed refers to the dtb_plugin table. There seems to be a difference.

Enabling the EC-CUBE plug-in

docker-compose exec --user apache web ./bin/console eccube:plugin:enable --code=SalesReport4

• If there are other installed plugins, change the part of SalesReport4 and execute it.

Cache generation

docker-compose exec --user apache web ./bin/console cache:warmup

: point_up_tone2: When clearing the cache

docker-compose exec --user apache web ./bin/console cache:clear --no-warmup

Access confirmation

It's OK if you open http: // localhost and see the default shop.

: no_entry_sign: The URL depends on the docker image you used.

Reference link

• Install the plug-in on EC-CUBE4 with a command from the owner's store
• EC-CUBE4 original plug-in development ② Original plug-in development tips
• Causes and preventive measures for plug-in errors in EC-CUBE 4 series