clean-docker / magento2

Docker Image to Magento 2 local development in Mac, Linux and Windows

Magento 2 Docker to Development

Apache 2.4 + PHP 7.1 + OPCache + MariaDB + N98 Magerun 2 + XDebug + Redis

Requirements

MacOS:

Install Docker, Docker-compose and Docker-sync.

Windows:

Install Docker, Docker-compose and Docker-sync.

Linux:

Install Docker and Docker-compose.

How to use

Execute in your terminal, change the MYMAGENTO2 to use the name of your project:

curl -s https://raw.githubusercontent.com/clean-docker/Magento2/master/init | bash -s MYMAGENTO2 clone

If you want to install the Magento 2, use like that:

cd MYMAGENTO2
./shell
rm index.php
install-magento2

You can specify the version that want install (e.g. install-magento2 2.2).

Panels

Enjoy your new panels!

Web server: http://localhost/

PHPMyAdmin: http://localhost:8080

Local emails: http://localhost:8025

Features commands

Commands	Description	Options & Examples
./init	If you didn't use the CURL setup command above, please use this command changing the name of the project.	./init MYMAGENTO2
./start	If you continuing not using the CURL you can start your container manually
./stop	Stop your project containers
./kill	Stops containers and removes containers, networks, volumes, and images created to the specific project
./shell	Access your container	./shell root
./magento	Use the power of the Magento CLI
./n98	Use the Magerun commands as you want
./grunt-init	Prepare to use Grunt
./grunt	Use Grunt specifically in your theme or completely, it'll do the deploy and the watcher.	./grunt luma
./xdebug	Enable / Disable the XDebug
./composer	Use Composer commands	./composer update

Elasticsearch

To use elastic search you can use this command below:

$ docker-compose -f docker-compose.yml -f docker-compose.elasticsearch.yml up

or to run in the background using detached mode

$ docker-compose -f docker-compose.yml -f docker-compose.elasticsearch.yml up -d

Elasticsearch: http://localhost:9200

License

MIT © 2018 Rafael Corrêa Gomes and contributors.

magento2's Issues

Add Redis CLI Tools

Add apt install -y redis-tools to be able to use this command below in Apache container to flush the Redis cache.

redis-cli -h redis flushall
redis-cli -h redis-session flushall

Show User / Password when install M2

Improve the output when M2 was installed using the install-magento2 script.

.npm and .composer folder permissions

Linux dist: Fedora

When running the command to install Magento, there were some problems with creating the Composer cache folder and at the end several errors related to NPM.

This is why when installing Magento we are using the "www-data" user privileges and the folder /var/www/.npm and /var/www/.composer are the user "root"

I solved only with these two commands:

docker-compose exec --user root apache chown www-data:www-data /var/www/.npm -Rf
docker-compose exec --user root apache chown www-data:www-data /var/www/.composer -Rf

I believe you can implement a better solution directly in DockerFile.

Thanks for sharing this solution.

How enable mysqli?

How I can enable mysqli for php?
I try to use direct sql query calls but got error.

Fatal error: Uncaught Error: Call to undefined function mysqli_connect()

Permissão Pasta

Rafael,

precisa de alguma permissão específica na pasta? tô tentando subir essa docker, mas quando vai installar o magento dá alguns erros de permissão, e também na hora de rodar o script do redis também dá erro.

Sabe me dizer se qual melhor OS para eu subir ?

How to change the directories being synced

I'm trying to sync the vendor dir, so i removed the corresponding lines in docker-sync.yml, stopped and started the containers again, but the changes have no effect. How can I achieve this?

Wich is the root password ?

Wich is the root password ? Because cant run the command "install-magento2".
It said "Operation not permitted".
Thanks

Install Bash Completition

Add the commands

apt install bash-completion
RUN curl -o /etc/bash_completion.d/m2install-bash-completion https://raw.githubusercontent.com/yvoronoy/m2install/master/m2install-bash-completion
RUN curl -o /etc/bash_completion.d/n98-magerun2.phar.bash https://raw.githubusercontent.com/netz98/n98-magerun2/master/res/autocompletion/bash/n98-magerun2.phar.bash
RUN echo "source /etc/bash_completion" >> /root/.bashrc

Cron installed by default

Like the setup-cron.

What is the mysql password?

I tried alternatives many times but it did not happen. Could you say mysql password?

Error when installing magento2

Installation stuck at generating autoload files step. Interestingly the first few installations are fine but I get into this issue afterward. Can't get rid of the issue even after removing containers, images, volumes and even composer cache. Please help me.

Writing lock file
Generating autoload files

                                                          
  [Symfony\Component\Console\Exception\RuntimeException]  
  Too many arguments, expected arguments "command".       
                                                          

setup:install [--backend-frontname BACKEND-FRONTNAME] [--key KEY] [--db-host DB-HOST] [--db-name DB-NAME] [--db-user DB-USER] [--db-engine DB-ENGINE] [--db-password DB-PASSWORD] [--db-prefix DB-PREFIX] [--db-model DB-MODEL] [--db-init-statements DB-INIT-STATEMENTS] [-s|--skip-db-validation] [--http-cache-hosts HTTP-CACHE-HOSTS] [--session-save SESSION-SAVE] [--session-save-redis-host SESSION-SAVE-REDIS-HOST] [--session-save-redis-port SESSION-SAVE-REDIS-PORT] [--session-save-redis-password SESSION-SAVE-REDIS-PASSWORD] [--session-save-redis-timeout SESSION-SAVE-REDIS-TIMEOUT] [--session-save-redis-persistent-id SESSION-SAVE-REDIS-PERSISTENT-ID] [--session-save-redis-db SESSION-SAVE-REDIS-DB] [--session-save-redis-compression-threshold SESSION-SAVE-REDIS-COMPRESSION-THRESHOLD] [--session-save-redis-compression-lib SESSION-SAVE-REDIS-COMPRESSION-LIB] [--session-save-redis-log-level SESSION-SAVE-REDIS-LOG-LEVEL] [--session-save-redis-max-concurrency SESSION-SAVE-REDIS-MAX-CONCURRENCY] [--session-save-redis-break-after-frontend SESSION-SAVE-REDIS-BREAK-AFTER-FRONTEND] [--session-save-redis-break-after-adminhtml SESSION-SAVE-REDIS-BREAK-AFTER-ADMINHTML] [--session-save-redis-first-lifetime SESSION-SAVE-REDIS-FIRST-LIFETIME] [--session-save-redis-bot-first-lifetime SESSION-SAVE-REDIS-BOT-FIRST-LIFETIME] [--session-save-redis-bot-lifetime SESSION-SAVE-REDIS-BOT-LIFETIME] [--session-save-redis-disable-locking SESSION-SAVE-REDIS-DISABLE-LOCKING] [--session-save-redis-min-lifetime SESSION-SAVE-REDIS-MIN-LIFETIME] [--session-save-redis-max-lifetime SESSION-SAVE-REDIS-MAX-LIFETIME] [--cache-backend CACHE-BACKEND] [--cache-backend-redis-server CACHE-BACKEND-REDIS-SERVER] [--cache-backend-redis-db CACHE-BACKEND-REDIS-DB] [--cache-backend-redis-port CACHE-BACKEND-REDIS-PORT] [--page-cache PAGE-CACHE] [--page-cache-redis-server PAGE-CACHE-REDIS-SERVER] [--page-cache-redis-db PAGE-CACHE-REDIS-DB] [--page-cache-redis-port PAGE-CACHE-REDIS-PORT] [--page-cache-redis-compress-data PAGE-CACHE-REDIS-COMPRESS-DATA] [--base-url BASE-URL] [--language LANGUAGE] [--timezone TIMEZONE] [--currency CURRENCY] [--use-rewrites USE-REWRITES] [--use-secure USE-SECURE] [--base-url-secure BASE-URL-SECURE] [--use-secure-admin USE-SECURE-ADMIN] [--admin-use-security-key ADMIN-USE-SECURITY-KEY] [--admin-user ADMIN-USER] [--admin-password ADMIN-PASSWORD] [--admin-email ADMIN-EMAIL] [--admin-firstname ADMIN-FIRSTNAME] [--admin-lastname ADMIN-LASTNAME] [--cleanup-database] [--sales-order-increment-prefix SALES-ORDER-INCREMENT-PREFIX] [--use-sample-data] [--magento-init-params MAGENTO-INIT-PARAMS]

/usr/local/bin/install-magento2: line 26: --session-save-redis-host=redis-session: command not found

Windows10

Would be nice to have clear instruction running for windows10
with docker, docket-compose and docker-sync .
Command by command tutorial.
Now i am stuck that : Can not connect to docker at 127.0.0.1:2375

Losing Magento configuration after docker-compose down

Hello, this may just be a newbie question - been messing with this for 3 days.

I can get Magento 2 up and running with this package on my MacOS running High Sierra v10.13.6, but then after a while, or after I ./stop and ./start the docker instances, something goes wrong with my Magento configuration and I end up with these errors on the screen (and nothing else):

`Warning: Unknown: failed to open stream: No such file or directory in Unknown on line 0

Fatal error: Unknown: Failed opening required '/app/magento-vars.php' (include_path='.:/usr/local/lib/php') in Unknown on line 0`

I have even tried using docker commit in another terminal window, but then when I stop and start or docker-compose down and up the same thing happens. HELP! :)

patrick

magento 2.3

magento 2.3 setup
the magento 2.3 is avaliable with this setup?

Language Spanish

Hello! I am trying use package to translate magento to spanish using this tutorial: https://www.mageplaza.com/magento-2-spanish-language-pack.html
But I can't do it.

Someone know how do it?
Thanks!

Couple of questions

Hi there, I have a couple of questions.

Changing the hostname. Is this possible, and if so, how do I do it? localhost doesn't work that great with chrome and some forms.

cron job. I can't get this to run the correct way, the customer grid is never updated. Any thoughts?

One or more integrations have been reset because of a change to their xml configs. I have been getting this error since the start, and cant start the integration. Never seen this before, do I have to do something about it?

PhP 7.0

Hi,

Recently you haev upgraded the image to php 7.1 Thanks a lot for that.
However, I still have one project Magento 2.1, Which only runs on PhP 7.0
Is there a way to get the old docker image with PhP 7.0 ?

Thanks for your reply.

Jelle

[question] How to properly configure marketplace-eqp?

I'm using your image and its great!

The only thing I couldn't set is the configuration for marketplace-eqp in my IDE.

I'm using Netbeans but I think it should be the same configurations as in PHPStorm.

Can you share your configuration to set the phpcs installed on docker in my local IDE?

Thanks in advanced.

Optimizing composer load

Install the composer extension below to improve the composer load time.

composer global require hirak/prestissimo

A question: Sudo rights?

Hello, I'm on mac OS and I want to start with saying this package is awesome.
Now to the question: When I use the install script: curl -s https://raw.githubusercontent.com/clean-docker/Magento2/master/init | bash -s MYMAGENTO2 clone
I get prompted for sudo twice during the installation, i canceled both of them and the installation continues and the project still seams to work.

My question, why does it need sudo rights? And also, am I missing something since i didn't provide sudo access?

[FIX] Enabling XDebug on Linux isn't working

The Xdebug isn't working in Linux without enabling the xdebug.remote_connect_back in this file https://github.com/clean-docker/Magento2/blob/master/.docker/config/custom-xdebug.ini

chmod: cannot access './var': No such file or directory

Hello Rafael!

First of all, thanks for this docker project, it will surely help me in many ways I can't even imagine :)

Sadly, I'm having a hard time getting the container to properly work. When I try to run install-magento2 I got this error message:

root@1500be452086:/var/www/html# install-magento2
Do not run Composer as root/super user! See https://getcomposer.org/root for details
Installing magento/project-community-edition (2.2.1)
  - Installing magento/project-community-edition (2.2.1): Loading from cache
Created project in .
Loading composer repositories with package information
Updating dependencies (including require-dev)
/usr/local/bin/install-magento2: line 6:    76 Killed                  composer create-project --repository-url=https://repo.magento.com/ magento/project-community-edition .
chmod: cannot access './var': No such file or directory
chmod: cannot access './vendor': No such file or directory
chmod: cannot access './pub/static': No such file or directory
chmod: cannot access './pub/media': No such file or directory
chmod: cannot access './app/etc': No such file or directory
mv: cannot stat 'package.json.sample': No such file or directory
mv: cannot stat 'Gruntfile.js.sample': No such file or directory

What am I doing wrong? I'm using DigitalOcean's one-click apps for Docker on Ubuntu 16.04. https://www.digitalocean.com/products/one-click-apps/docker/

Best.

Error for new Project

I have followed instructions for a new Magento 2 project, here is are my errors:

www-data@c3bf91ff81c6:~/html$ install-magento2
Cannot create cache directory /var/www/.composer/cache/repo/https---packagist.org/, or directory is not writable. Proceeding without cache
Cannot create cache directory /var/www/.composer/cache/files/, or directory is not writable. Proceeding without cache
Cannot create cache directory /var/www/.composer/cache/repo/https---repo.magento.com/, or directory is not writable. Proceeding without cache
                                                                                                                                             
    Authentication required (repo.magento.com):
      Username: ab8b9e3fb2346f4ec5b3972f302d9572
      Password: 
Do you want to store credentials for repo.magento.com in /var/www/.composer/auth.json ? [Yn] y
Installing magento/project-community-edition (2.2.2)
Cannot create cache directory /var/www/.composer/cache/files/, or directory is not writable. Proceeding without cache

                                      
  [InvalidArgumentException]          
  Project directory ./ is not empty.  
                                      

create-project [-s|--stability STABILITY] [--prefer-source] [--prefer-dist] [--repository REPOSITORY] [--repository-url REPOSITORY-URL] [--dev] [--no-dev] [--no-custom-installers] [--no-scripts] [--no-progress] [--no-secure-http] [--keep-vcs] [--no-install] [--ignore-platform-reqs] [--] [<package>] [<directory>] [<version>]

chmod: cannot access './var': No such file or directory
chmod: cannot access './vendor': No such file or directory
chmod: cannot access './pub/static': No such file or directory
chmod: cannot access './pub/media': No such file or directory
chmod: cannot access './app/etc': No such file or directory
'/var/www/env.sample.php' -> './app/etc/env.php'
cp: cannot create regular file './app/etc/env.php': No such file or directory
cp: cannot create regular file 'var/composer_home/auth.json': No such file or directory
mv: cannot stat 'package.json.sample': No such file or directory
mv: cannot stat 'Gruntfile.js.sample': No such file or directory
npm WARN enoent ENOENT: no such file or directory, open '/var/www/html/package.json'
npm WARN html No description
npm WARN html No repository field.
npm WARN html No README data
npm WARN html No license field.
Could not open input file: ./bin/magento

Not working in Windows 10

i'm trying using Windows 10 Pro and can't make it work. When i make a fresh install, everything goes fine. However, when i start customizing my project, executing setup:compile results in:
Warning: include(/var/www/html/vendor/composer/../../generated/code/Magento/Framework/App/ResourceConnection/Proxy.php): failed to open stream: No such file or directory in /var/www/html/vendor/composer/ClassLoader.php on line 444

In addition, logs start to show this error:
Class Magento\Framework\App\ResourceConnection\Config\Reader\Proxy generation error: The requested class did not generate properly, because the 'generated' directory permission is read-only. If --- after running the 'bin/magento setup:di:compile' CLI command when the 'generated' directory permission is set to write --- the requested class did not generate properly, then you must add the generated class object to the signature of the related construct method, only. [] []

i tried absolutely everything without success. I guess that the issue is related to www-data user permissions, since every file under apache container has root as owner. So i manually edited /etc/group file in order to gran permissions, like that:
root:x:0:www-data
But issue still happens.

In addition, i have to say that i used to work with Windows 10 Home and Docker Toolbox, and have no permission issues, but it worked really slowly. That's the main reason i switched to Windows 10 Pro.

Any help will be appreciated.
Thanks in advance,
Antonio

SQLSTATE[HY000] [1045] Access denied for user 'magento'@'172.20.0.7' (using password: YES)

After I do install-magento2 It gives me this error. Do you know how to fix it? I'm newbie in magento and docker

Thanks

Add generated folder

Add generated/ folder in ignored list.

Show version when start

Add versionment and show it on the launch screen!

can I rebuild the image so I can integrate an extension?

I see that in the src directory is the source code of magento. How could I rebuild the image in order to add modified source code I want to test? This is because I want to test an integration.
Thanks.

Frontend Session Issue

Hi

I've setup and installed Magento and can successfully log into the backend and perform admin tasks.

However, when it comes to the frontend I cannot add items to the cart or create a new account.

When adding an item the "Add Item" button just spins and loads although looking at the request tab the request completes.
When creating a new account from the frontend the page simply reloads with all registration fields being empty.

I've tried modifying the src/app/etc/env.php file, setting the value of the session key to

• db
• files
  (and then running php ./bin/magento setup:di:compile and php ./bin/magento setup:static-content:deploy)
  without success.

I'd appreciate any help.

Thanks a lot for making this by the way.

Permission /var/www/.composer

Can you provide the root password so we can be able to change permissions for composer cache?

Composer Runtime Exception

When I run "install-magento2" composer throws the following error:

RuntimeException
Could not delete ./:

Things I've tried so far:

1. changing ownership and permission on html folder but I learned that the way docker does volumes makes these commands not work as expected in the container shell
2. Almighty Google

I'm still a noob to docker so I would appreciate any help or advise to get this working. I would like to use Docker as Magento dev environment for home and work if possible. I'm pretty sure I can just git clone the Magento 2 repo or something like that but I would just like to know how to actually fix this issue when it arises.

Fix Permition in .composer

We need to fix permition in /var/www/composer

Cannot create cache directory /var/www/.composer/cache/repo/https---repo.magento.com/, or directory is not writable. Proceeding without cache Cannot create cache directory /var/www/.composer/cache/repo/https---repo.packagist.org/, or directory is not writable. Proceeding without cache Cannot create cache directory /var/www/.composer/cache/files/, or directory is not writable. Proceeding without cache

PhP 7.1

Great docker, using it for all my projects!

Is it easy to upgrade it to PHP 7.1?
Need it for Magento 2.2.5

Thanks in advance

How to perform magento rollback from docker image

I need to create CI/CD pipeline using Magento 2 docker image. As there are commands like "magento setup:rollback --code-file="...." in normal Magento environment. Can I have same setup like this in docker image? How can I issue rollback command from docker image.

docker-compose-dev.yml is not used

In the mac/windows version of the start script the following changes seem to be needed to use the docker-sync volume properly:
....
docker-sync start &&
docker-compose up -d &&
....
docker-sync start &&
docker-compose -f docker-compose.yml -f docker-compose-dev.yml up -d &&
....
If "docker-sync-stack start" is used as described in https://github.com/EugenMayer/docker-sync/wiki/Keep-your-docker-compose.yml-portable, it picks up docker-compose-dev.yml, otherwise the setup seems to lack docker-compose-dev.yml and it all ends up with a native - and quite slow - volume mount.

ServerName

@rafaelstz só uma questão,

Caso eu queira rodar sem ser em localhost , eu consigo alterar o ServerName para o endereço do site ?

Att

PHPstorm config / empty vendor folder

I installed this Magento 2 Docker container, it runs very fast on the basic Luma theme.
However, I can't make any changes to files, as the vendor folder is empty in phpstorm.

Did I setup the project incorrectly?

Http to Https

@rafaelstz Cara, você tem me ajudado muito com essa dock, mas mano de alguma forma consigo aplicar um letsencrypt ou outro certificado e mudar de http para https?

Valeu @rafaelstz

the input device is not a TTY. If you are using mintty, try prefixing the command with 'winpty'

$ ./shell

the input device is not a TTY.  If you are using mintty, try prefixing the command with 'winpty'

How to run that in WSL?

Sobre o uso de link simbólico

Boa Tarde

Sobre o uso de link simbólico

Conforme imagens

Vemos que não está funcionando a exibição do link simbólico

Veja que no host eu criei um arquivo fisico e um link simbolico na pasta "src" do Container, mas somente o arquivo fisico é exibido

Pode me ajudar ?

env: bash\r: No such file or directory

I've just made setup of env and a project. When running CURL command to init I get:

env: bash\r: No such file or directory

Git reset commands

These commands are used to prevent issues.

git config --global core.autocrlf false
git config --global core.eol LF
git config --global diff.renamelimit 5000

Erro instalação Windows 10 - Ubuntu WSL

Oi Rafael, estou com um probleminha.
Tentei rodar a instalação seguindo o seu tutorial, mas no Ubuntu WSL no Windows 10 não está terminando a instalação.
Logo depois de rodar o install-magento2 ele passa vários minutos instalando várias coisas, mas depois de um tempo este erro aparece:

Cannot read contents from file "/var/www/html/app/etc/di.xml" Warning!file_get_contents(/var/www/html/app/etc/di.xml): failed to open stream: No such file or directory
'/var/www/env.sample.php' -> './app/etc/env.php'
/usr/local/bin/install-magento2: line 27: n98: command not found
Cannot read contents from file "/var/www/html/app/etc/di.xml" Warning!file_get_contents(/var/www/html/app/etc/di.xml): failed to open stream: No such file or directory
cp: cannot stat '/var/www/.composer/auth.json': No such file or directory
npm ERR! Linux 4.9.87-linuxkit-aufs
npm ERR! argv "/usr/bin/node" "/usr/bin/npm" "i"
npm ERR! node v6.14.3
npm ERR! npm v3.10.10
npm ERR! path /var/www/.npm/time-grunt
npm ERR! code EACCES
npm ERR! errno -13
npm ERR! syscall mkdir

npm ERR! Error: EACCES: permission denied, mkdir '/var/www/.npm/time-grunt'
npm ERR! at Error (native)
npm ERR! { Error: EACCES: permission denied, mkdir '/var/www/.npm/time-grunt'
npm ERR! at Error (native)
npm ERR! errno: -13,
npm ERR! code: 'EACCES',
npm ERR! syscall: 'mkdir',
npm ERR! path: '/var/www/.npm/time-grunt',
npm ERR! parent: 'magento2' }
npm ERR!
npm ERR! Please try running this command again as root/Administrator.

npm ERR! Please include the following file with any support request:
npm ERR! /var/www/html/npm-debug.log
Cannot read contents from file "/var/www/html/app/etc/di.xml" Warning!file_get_contents(/var/www/html/app/etc/di.xml): failed to open stream: No such file or directory

Sabe o que pode ser? Algo que eu imagino é que como estou rodando o comando do WSL e o docker dentro do Ubuntu conecta ao Docker que roda no Windows, o Ubuntu talvez não esteja tendo permissão de escrita. Já tive problema parecido com o MySQL, mas já resolvi localmente.

Obrigado.

Ignoring pub/media/ causes images to 404

On the mac branch, the docker-sync.yml explicitly ignores pub/media/*. That's causing all media files to be invisible to the apache container, and therefore they can't be served on my development site. I see that was done to prevent too many files from syncing constantly, but what's the workaround to get media images loading?

docker-sync stops working after some idle time

When i start or stop and the start the containers everything works as expected. But after some idle time (approx. 3 or 4 minutes) further changes in the file system are not noticed anymore. In the daemon.log i connot find any hints why it's not working... any ideas?

PhP7 imagick

Good evening,

I am happily using your image for my magento development.
For a new project i need to have php-imagick installed, but I can'figure out how to do so.
Normally I am used to work with Ubuntu ....

Do you have any advise how to install imagick on this docker container?

What is the root password?

I installed this and got Magento2 up and going. Thank you.

I copied an app folder into the root directory because I am installing a plugin. For some reason teh shell and Magento are unable to read the contents of this folder.

I'm trying to troubleshoot the issue. I am trying to run this command: su -c "setenforce 0"

But I'm being prompted for the root password. What is the root password for this container? I've tried admin and root but no luck. Thank you

Authentication required (repo.magento.com) what does it mean?

I typed
install-magento2
then ask me for a username and password
what is the username and the password ?

Invalid credentials when install-magento2

Hi, I managed to install this docker image with ./init, but when I install-magento2 via ./shell, I got Authentication required (repo.magento.com) prompt. I was sure inputting my login credential, but it still threw error:

[Composer\Downloader\TransportException]
Invalid credentials for 'https://repo.magento.com/packages.json', aborting.

Install Modgit and Modman

They are very useful tools.