kojiromike/magento_tools repository overview

⁠Magento Docker Tools Container

This container isn't configured in docker-compose because it's intended to be run manually. You can use it to install Magento⁠, or to get access to the filesystem for running tools. You don't even have to build it yourself.

⁠Pull It

docker pull kojiromike/magento_tools:latest

⁠Or, Build It Yourself

docker build --rm tools

⁠Run It

⁠Note: Container Names

This project is more useful when you can create multiple docker containers for various Magento projects. To do that, you will need to vary the names of those projects using either the -p flag, the COMPOSE_PROJECT_NAME⁠ or the basename of the current working directory (but only alphanumeric characters are included).

To get started quickly with a consistent name based on the current directory, run the following:

export COMPOSE_PROJECT_NAME
COMPOSE_PROJECT_NAME="${PWD##*/}"
COMPOSE_PROJECT_NAME="${COMPOSE_PROJECT_NAME//[^[:alnum:]]}"

The below commands all assume you have COMPOSE_PROJECT_NAME in the current environment.

⁠Magento Reindex

docker run --rm --link "${COMPOSE_PROJECT_NAME}"_db_1:db_1 \
           --volumes-from "${COMPOSE_PROJECT_NAME}"_data_1 \
           kojiromike/magento_tools \
           php shell/indexer.php reindexall

⁠Shell Access for Arbitrary Commands

docker run --rm --link "${COMPOSE_PROJECT_NAME}"_db_1:db_1 \
           --volumes-from "${COMPOSE_PROJECT_NAME}"_data_1 \
           -ti kojiromike/magento_tools bash

⁠Install Magento

After setting up the service containers as described in the main README⁠, you can use this container to install Magento.

⁠Choose a Magento

Either untar a Magento into /srv/magento or provide a tarball mounted at /magento.tar as in the example below. Link the MySQL service and data volume containers, and optionally set MAGENTO_HOST to the hostname or ip address of the Docker host.

You can do this with:

docker run --rm --link "${COMPOSE_PROJECT_NAME}"_db_1:db_1 \
           --volumes-from "${COMPOSE_PROJECT_NAME}"_data_1 \
           --volume /path/to/magento.tar:/magento.tar \
           --volume /path/to/magento-sample-data.tar:/sample.tar \ # Optional
           --env MAGENTO_HOST=$(boot2docker ip) \ # Optional
           kojiromike/magento_tools /usr/local/bin/install_magento

⁠Available Tools:

• MySQL Client⁠
• PHP Copy/Paste Detector⁠
• PHP Depend⁠
• PHP Mess Detector⁠
• PHPUnit⁠
• PHP_CodeSniffer⁠
• cURL⁠
• composer⁠
• git⁠
• modman⁠
• n98-magerun⁠
• phpDocumentor⁠
• phploc⁠
• vim⁠
• xdebug⁠

⁠XDebug Notes

XDebug can slow down PHP significantly, so it is not enabled by default. To enable xdebug, you can specify it on the php commandline. For example, to generate PHPUnit code coverage reports:

php -d zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20121212/xdebug.so \
    vendor/bin/phpunit --coverage-html coverage-html