- mkdir magentoee241
- cd magentoee241
curl -s https://raw.githubusercontent.com/markshust/docker-magento/master/lib/template | bash
- mkdir src
- unzip magento241.zip to folder src
FIND docker-compose.dev.yml edit docker-compose.dev.yml
app:
volumes: &appvolumes
# Host mounts with performance penalty, only put what is necessary here
# - ./src/app/code:/var/www/html/app/code:cached
# - ./src/app/design:/var/www/html/app/design:cached
# - ./src/app/etc:/var/www/html/app/etc:cached
# - ./src/composer.json:/var/www/html/composer.json:cached
# - ./src/composer.lock:/var/www/html/composer.lock:cached
# - ./src/nginx.conf.sample:/var/www/html/nginx.conf:cached
#- ./src/auth.json:/var/www/html/auth.json:cached
#- ./src/m2-hotfixes:/var/www/html/m2-hotfixes:cached
#- ./src/patches:/var/www/html/patches:cached
#- ./src/var/log:/var/www/html/var/log:cached
#- ./src/var/report:/var/www/html/var/report:cached
# To sync your SSH to the container, uncomment the following line:
#- ~/.ssh/id_rsa:/var/www/.ssh/id_rsa:cached
# Linux only: remove the above lines and mount the entire src directory with:
- ./src:/var/www/html:cached
- Wait 5s
bin/clinotty bin/magento setup:install \
--db-host=db \
--db-name=magentoee241 \
--db-user=magento \
--db-password=magento \
--base-url=https://magentoee241.docker/ \
--base-url-secure=https://magentoee241.docker/ \
--backend-frontname=admin \
--admin-firstname=John \
--admin-lastname=Smith \
--admin-email=john.smith@gmail.com \
--admin-user=admin \
--admin-password=123123q \
--language=en_US \
--currency=USD \
--timezone=America/New_York \
--amqp-host=rabbitmq \
--amqp-port=5672 \
--amqp-user=guest \
--amqp-password=guest \
--amqp-virtualhost=/ \
--cache-backend=redis \
--cache-backend-redis-server=redis \
--cache-backend-redis-db=0 \
--page-cache=redis \
--page-cache-redis-server=redis \
--page-cache-redis-db=1 \
--session-save=redis \
--session-save-redis-host=redis \
--session-save-redis-log-level=4 \
--session-save-redis-db=2 \
--search-engine=elasticsearch7 \
--elasticsearch-host=elasticsearch \
--use-rewrites=1
bin/clinotty bin/magento deploy:mode:set developer
bin/clinotty bin/magento indexer:reindex
bin/clinotty bin/magento setup:static-content:deploy -f
bin/clinotty bin/magento indexer:reindex
bin/clinotty bin/magento cache:flush
bin/setup-ssl magentoee241.docker
FIND docker-compose.dev.yml edit docker-compose.dev.yml
app:
volumes: &appvolumes
# Host mounts with performance penalty, only put what is necessary here
# - ./src/app/code:/var/www/html/app/code:cached
# - ./src/app/design:/var/www/html/app/design:cached
# - ./src/app/etc:/var/www/html/app/etc:cached
- ./src/composer.json:/var/www/html/composer.json:cached
- ./src/composer.lock:/var/www/html/composer.lock:cached
- ./src/nginx.conf.sample:/var/www/html/nginx.conf:cached
#- ./src/auth.json:/var/www/html/auth.json:cached
#- ./src/m2-hotfixes:/var/www/html/m2-hotfixes:cached
#- ./src/patches:/var/www/html/patches:cached
#- ./src/var/log:/var/www/html/var/log:cached
#- ./src/var/report:/var/www/html/var/report:cached
# To sync your SSH to the container, uncomment the following line:
#- ~/.ssh/id_rsa:/var/www/.ssh/id_rsa:cached
# Linux only: remove the above lines and mount the entire src directory with:
- ./src:/var/www/html:cached
- bin/restart
FIND docker-compose.dev.yml edit docker-compose.dev.yml
phpmyadmin:
image: phpmyadmin/phpmyadmin
ports:
- 81:80
depends_on:
- db
- bin/restart
For more details on how everything works, see the extended setup readme.
bin/bash
: Drop into the bash prompt of your Docker container. Thephpfpm
container should be mainly used to access the filesystem within Docker.bin/cli
: Run any CLI command without going into the bash prompt. Ex.bin/cli ls
bin/clinotty
: Run any CLI command with no TTY. Ex.bin/clinotty chmod u+x bin/magento
bin/composer
: Run the composer binary. Ex.bin/composer install
bin/copyfromcontainer
: Copy folders or files from container to host. Ex.bin/copyfromcontainer vendor
bin/copytocontainer
: Copy folders or files from host to container. Ex.bin/copytocontainer --all
bin/dev-urn-catalog-generate
: Generate URN's for PHPStorm and remap paths to local host. Restart PHPStorm after running this command.bin/devconsole
: Alias forbin/n98-magerun2 dev:console
bin/download
: Download & extract specific Magento version to thesrc
directory. If the archive download fails, it will attempt to download with Composer. Ex.bin/download 2.4.1
.bin/fixowns
: This will fix filesystem ownerships within the container.bin/fixperms
: This will fix filesystem permissions within the container.bin/grunt
: Run the grunt binary. Ex.bin/grunt exec
bin/magento
: Run the Magento CLI. Ex:bin/magento cache:flush
bin/mysql
: Run the MySQL CLI with database config fromenv/db.env
. Ex.bin/mysql -e "EXPLAIN core_config_data"
orbin/mysql < backups/magento.sql
bin/mysqldump
: Backup the Magento database. Ex.bin/mysqldump > backups/magento.sql
bin/n98-magerun2
: Access the n98 magerun CLI. Ex:bin/n98-magerun2 dev:console
bin/node
: Run the node binary. Ex.bin/node --version
bin/npm
: Run the npm binary. Ex.bin/npm install
bin/pwa-studio
: (BETA) Start the PWA Studio server. Note that Chrome will throw SSL cert errors and not allow you to view the site, but Firefox will.bin/redis
: Run a command from the redis container. Ex.bin/redis redis-cli monitor
bin/remove
: Remove all containers.bin/removeall
: Remove all containers, networks, volumes, and images.bin/removevolumes
: Remove all volumes.bin/restart
: Stop and then start all containers.bin/root
: Run any CLI command as root without going into the bash prompt. Exbin/root apt-get install nano
bin/rootnotty
: Run any CLI command as root with no TTY. Exbin/rootnotty chown -R app:app /var/www/html
bin/setup
: Run the Magento setup process to install Magento from the source code, with optional domain name. Defaults tomagento2.test
. Ex.bin/setup magento2.test
bin/setup-grunt
: Install and configure Grunt JavaScript task runner to compile .less filesbin/setup-pwa-studio
: (BETA) Install PWA Studio (requires NodeJS and Yarn to be installed on the host machine). Pass in your base site domain, otherwise the defaultmaster-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud
will be used. Ex:bin/setup-pwa-studio magento2.test
bin/setup-ssl
: Generate an SSL certificate for one or more domains. Ex.bin/setup-ssl magento2.test magento3.test
bin/setup-ssl-ca
: Generate a certificate authority and copy it to the host.bin/start
: Start all containers, good practice to use this instead ofdocker-compose up -d
, as it may contain additional helpers.bin/status
: Check the container status.bin/stop
: Stop all containers.bin/update
: Update your project to the most recent version ofdocker-magento
.bin/xdebug
: Disable or enable Xdebug. Accepts paramsdisable
(default) orenable
. Ex.bin/xdebug enable
The hostname of each service is the name of the service within the docker-compose.yml
file. So for example, MySQL's hostname is db
(not localhost
) when accessing it from within a Docker container. Elasticsearch's hostname is elasticsearch
.
To connect to the MySQL CLI tool of the Docker instance, run:
bin/mysql
You can use the bin/mysql
script to import a database, for example a file stored in your local host directory at backups/magento.sql
:
bin/mysql < backups/magento.sql
You also can use bin/mysqldump
to export the database. The file will appear in your local host directory at backups/magento.sql
:
bin/mysqldump > backups/magento.sql
First setup Magento Marketplace authentication (details in the DevDocs).
Copy src/auth.json.sample
to src/auth.json
. Then, update the username and password values with your Magento public and private keys, respectively. Finally, copy the file to the container by running bin/copytocontainer auth.json
.
View emails sent locally through Mailhog by visiting http://{yourdomain}:8025
Redis is now the default cache and session storage engine, and is automatically configured & enabled when running bin/setup
on new installs.
Use the following lines to enable Redis on existing installs:
Enable for Cache:
bin/magento config:set --cache-backend=redis --cache-backend-redis-server=redis --cache-backend-redis-db=0
Enable for Full Page Cache:
bin/magento config:set --page-cache=redis --page-cache-redis-server=redis --page-cache-redis-db=1
Enable for Session:
bin/magento config:set --session-save=redis --session-save-redis-host=redis --session-save-redis-log-level=4 --session-save-redis-db=2
You may also monitor Redis by running: bin/redis redis-cli monitor
For more information about Redis usage with Magento, see the DevDocs.
Install and enable the PHP Debug extension from the Visual Studio Marketplace.
Otherwise, this project now automatically sets up Xdebug support with VS Code. If you wish to set this up manually, please see the .vscode/launch.json
file.
-
First, install the Chrome Xdebug helper. After installed, right click on the Chrome icon for it and go to Options. Under IDE Key, select PHPStorm from the list and click Save.
-
Next, enable Xdebug in the PHP-FPM container by running:
bin/xdebug enable
, the restart the docker containers (CTRL+C thenbin/start
). -
Then, open
PHPStorm > Preferences > Languages & Frameworks > PHP
and configure:-
CLI Interpreter
- Create a new interpreter and specify
From Docker
, and name itmarkoshust/magento-php:7-2-fpm
. - Choose
Docker
, then select themarkoshust/magento-php:7-2-fpm
image name, and set thePHP Executable
tophp
.
- Create a new interpreter and specify
-
Path mappings
- Don't do anything here as the next
Docker container
step will automatically setup a path mapping from/var/www/html
to./src
.
- Don't do anything here as the next
-
Docker container
- Remove any pre-existing volume bindings.
- Ensure a volume binding has been setup for Container path of
/var/www/html
mapped to the Host path of./src
.
-
-
Open
PHPStorm > Preferences > Languages & Frameworks > PHP > Debug
and set Debug Port to9001
. -
Open
PHPStorm > Preferences > Languages & Frameworks > PHP > DBGp Proxy
and set Port to9001
. -
Open
PHPStorm > Preferences > Languages & Frameworks > PHP > Servers
and create a new server:- Set Name and Host to your domain name (ex.
magento2.test
) - Keep port set to
80
- Check the Path Mappings box and map
src
to the absolute path of/var/www/html
- Set Name and Host to your domain name (ex.
-
Go to
Run > Edit Configurations
and create a newPHP Remote Debug
configuration by clicking the plus sign and selecting it. Set the Name to your domain (ex.magento2.test
). Check theFilter debug connection by IDE key
checkbox, select the server you just setup, and under IDE Key enterPHPSTORM
. This IDE Key should match the IDE Key set by the Chrome Xdebug Helper. Then click OK to finish setting up the remote debugger in PHPStorm. -
Open up
src/pub/index.php
, and set a breakpoint near the end of the file. Go toRun > Debug 'magento2.test'
, and open up a web browser. Ensure the Chrome Xdebug helper is enabled by clicking on it > Debug. Navigate to your Magento store URL, and Xdebug within PHPStorm should now trigger the debugger and pause at the toggled breakpoint.