|
5 | 5 | [](https://hub.docker.com/r/alexcheng/magento2/) |
6 | 6 |
|
7 | 7 | This repo converts the [long installation guide](http://devdocs.magento.com/guides/v1.0/install-gde/bk-install-guide.html) of Magento 2 into simple Docker image to use. It uses the same convention as my [Docker image for Magento 1.x](https://github.com/alexcheng1982/docker-magento). |
| 8 | + |
| 9 | +For documentation, please refer to the Magento 1.x [repo](https://github.com/alexcheng1982/docker-magento). These two Docker images follow the same instructions. |
| 10 | + |
| 11 | +__Note__ This docker image uses the *Contributing developer* profile to install Magento, so it has limitations. See more details [here](http://devdocs.magento.com/guides/v2.0/install-gde/bk-install-guide.html). |
| 12 | + |
| 13 | +**Please note: this Docker image is for development and testing only, not for production use. Setting up a Magento 2 production server requires more configurations. Please refer to [official documentations](http://devdocs.magento.com/guides/v2.2/config-guide/deployment/).** |
| 14 | + |
| 15 | +## Magento 2 installation types |
| 16 | + |
| 17 | +Magento 2 has three different ways to [install](http://devdocs.magento.com/guides/v2.0/install-gde/bk-install-guide.html), for users, integrators and developers. This Docker image uses **integrator** as the default installation type, so the **Web Setup Wizard** can be used. For each version, both integrator and developer installation types are available. The user installation type is not currently supported. |
| 18 | + |
| 19 | +For example, Magento 2 version `2.2.2` has tag `2.2.2`, `2.2.2-integrator` and `2.2.2-developer`. `2.2.2` is the same as `2.2.2-integrator`. |
| 20 | + |
| 21 | +Below are some basic instructions. |
| 22 | + |
| 23 | +## Quick start |
| 24 | + |
| 25 | +The easiest way to start Magento 2 with MySQL is using [Docker Compose](https://docs.docker.com/compose/). Just clone this repo and run following command in the root directory. The default `docker-compose.yml` uses MySQL and phpMyAdmin. |
| 26 | + |
| 27 | +~~~ |
| 28 | +$ docker-compose up -d |
| 29 | +~~~ |
| 30 | + |
| 31 | +For admin username and password, please refer to the file `env`. You can also update the file `env` to update those configurations. Below are the default configurations. |
| 32 | + |
| 33 | +~~~ |
| 34 | +MYSQL_HOST=db |
| 35 | +MYSQL_ROOT_PASSWORD=myrootpassword |
| 36 | +MYSQL_USER=magento |
| 37 | +MYSQL_PASSWORD=magento |
| 38 | +MYSQL_DATABASE=magento |
| 39 | +
|
| 40 | +MAGENTO_LANGUAGE=en_GB |
| 41 | +MAGENTO_TIMEZONE=Pacific/Auckland |
| 42 | +MAGENTO_DEFAULT_CURRENCY=NZD |
| 43 | +MAGENTO_URL=http://local.magento |
| 44 | +MAGENTO_BACKEND_FRONTNAME=admin |
| 45 | +MAGENTO_USE_SECURE=0 |
| 46 | +MAGENTO_BASE_URL_SECURE=0 |
| 47 | +MAGENTO_USE_SECURE_ADMIN=0 |
| 48 | +
|
| 49 | +MAGENTO_ADMIN_FIRSTNAME=Admin |
| 50 | +MAGENTO_ADMIN_LASTNAME=MyStore |
| 51 | + |
| 52 | +MAGENTO_ADMIN_USERNAME=admin |
| 53 | +MAGENTO_ADMIN_PASSWORD=magentorocks1 |
| 54 | +~~~ |
| 55 | + |
| 56 | +For example, if you want to change the default currency, just update the variable `MAGENTO_DEFAULT_CURRENCY`, e.g. `MAGENTO_DEFAULT_CURRENCY=USD`. |
| 57 | + |
| 58 | +You can find all available options in the official [setup guide](http://devdocs.magento.com/guides/v2.0/install-gde/install/cli/install-cli-install.html#instgde-install-cli-magento). If you need more options, fork this repo and add them in `bin\install-magento`. |
| 59 | + |
| 60 | +Please see the following video for a quick demo. |
| 61 | + |
| 62 | +[](https://www.youtube.com/watch?v=18tOf_cuQKg "Use Magento 2 with Docker") |
| 63 | + |
| 64 | +## Installation |
| 65 | + |
| 66 | +After starting the container, you'll see the setup page of Magento 2. You can use the script `install-magento` to quickly install Magento 2. The installation script uses the variables in the `env` file. |
| 67 | + |
| 68 | +### Magento 2 |
| 69 | + |
| 70 | +~~~ |
| 71 | +$ docker exec -it <container_name> install-magento |
| 72 | +~~~ |
| 73 | + |
| 74 | +### Sample data |
| 75 | + |
| 76 | +~~~ |
| 77 | +$ docker exec -it <container_name> install-sampledata |
| 78 | +~~~ |
| 79 | + |
| 80 | +**Please note:** Sample data for Magento 2.2.2 doesn't work at the moment, see [this issue](https://github.com/alexcheng1982/docker-magento2/issues/11). |
| 81 | + |
| 82 | +### Database |
| 83 | + |
| 84 | +The default `docker-compose.yml` uses MySQL as the database and starts [phpMyAdmin](https://www.phpmyadmin.net/). The default URL for phpMyAdmin is `http://localhost:8580`. Use MySQL username and password to log in. |
| 85 | + |
| 86 | +## FAQ |
| 87 | + |
| 88 | +### Where is the database? |
| 89 | + |
| 90 | +Magento 2 cannot run with a database. This image is for Magento 2 only. It doesn't contain MySQL server. MySQL server should be started in another container and linked with Magento 2 container. It's recommended to use Docker Compose to start both containers. You can also use [Kubernetes](https://kubernetes.io/) or other tools. |
| 91 | + |
| 92 | +### Why accessing http://local.magento? |
| 93 | + |
| 94 | +For development and testing in the local environment, using `localhost` as Magento 2 URL has some issues. The default `env` file use `http://local.magento` as the value of `MAGENTO_URL`. You need to [edit your `hosts` file](https://support.rackspace.com/how-to/modify-your-hosts-file/) to add the mapping from `local.magento` to `localhost`. You can use any domain names as long as it looks like a real domain, not `localhost`. |
| 95 | + |
| 96 | +If `localhost` doesn't work, try using `127.0.0.1`. |
| 97 | + |
| 98 | +``` |
| 99 | +127.0.0.1 local.magento |
| 100 | +``` |
| 101 | + |
| 102 | +### How to update Magento 2 installation configurations? |
| 103 | + |
| 104 | +Depends on how the container is used, |
| 105 | + |
| 106 | +* When using the GUI setup page of Magento 2, update configurations in the UI. |
| 107 | +* When using the script, update configurations in the `env` file. |
| 108 | +* When starting Magento 2 as a standalone container, use `-e` to pass environment variables. |
| 109 | + |
| 110 | +### Why getting access denied error after changing the default DB password? |
| 111 | + |
| 112 | +If you change the default DB password in `env` file and get the access denied error when installing Magento 2, see [this issue comment](https://github.com/alexcheng1982/docker-magento2/issues/10#issuecomment-355382150). |
| 113 | + |
| 114 | +## Develop and test using this Docker image |
| 115 | + |
| 116 | +As I mentioned before, this Docker image is primarily used for development and testing. Depends on the tasks you are trying to do, there are different ways to use this Docker image. |
| 117 | + |
| 118 | +### Extensions and themes |
| 119 | + |
| 120 | +You can keep the extensions and themes directories on your local host machine, and use Docker Compose [volumes](https://docs.docker.com/compose/compose-file/#volumes) to install the extensions and themes. For example, if you have a theme in the directory `/dev/mytheme`, you can install it by specifying it in the `docker-composer.yml` file. Then you can see the theme in Magento admin UI. |
| 121 | + |
| 122 | +```yml |
| 123 | +version: '3.0' |
| 124 | +services: |
| 125 | + web: |
| 126 | + image: alexcheng/magento2 |
| 127 | + ports: |
| 128 | + - "80:80" |
| 129 | + links: |
| 130 | + - db |
| 131 | + env_file: |
| 132 | + - env |
| 133 | + volumes: |
| 134 | + - /dev/mytheme:/var/www/html/app/design/frontend/mytheme/default |
| 135 | + db: |
| 136 | + image: mysql:5.6.23 |
| 137 | + volumes: |
| 138 | + - db-data:/var/lib/mysql/data |
| 139 | + env_file: |
| 140 | + - env |
| 141 | + phpmyadmin: |
| 142 | + image: phpmyadmin/phpmyadmin |
| 143 | + ports: |
| 144 | + - "8580:80" |
| 145 | + links: |
| 146 | + - db |
| 147 | +volumes: |
| 148 | + db-data: |
| 149 | +``` |
| 150 | +
|
| 151 | +### Modify Magento core files |
| 152 | +
|
| 153 | +If you want to modify Magento core files, you cannot modify them directly in the container. Those changes will be lost. It's also not recommended to update Magento core files directly, which makes upgrading Magento a painful process. Actually, Docker makes the process much easier if you absolutely need to modify some core files. You can use volumes to overwrite files. |
| 154 | +
|
| 155 | +For example, if you want to overwrite the file `app/code/Magento/Catalog/Block/Product/Price.php`, you can copy the content to a new file in your local directory `/dev/mycode/magento_2_2` and make the changes, then use `volumes` to overwrite it. |
| 156 | + |
| 157 | +```yml |
| 158 | +volumes: |
| 159 | + - /dev/mycode/magento_2_2/app/code/Magento/Catalog/Block/Product/Price.php:/var/www/html/app/code/Magento/Catalog/Block/Product/Price.php |
| 160 | +``` |
| 161 | + |
| 162 | +By using Docker, we can make sure that all your changes to Magento core files are kept in one place and tracked in source code repository. These changes are also correctly aligned with different Magento versions. |
| 163 | + |
| 164 | +When deploying those changes to production servers, we can simply copy all files in the `/dev/mycode/magento_2_2` directory to Magento installation directory and overwrite existing files. |
| 165 | + |
| 166 | +### Test Magento compatibilities |
| 167 | + |
| 168 | +This Docker images has different tags for corresponding Magento versions, e.g. `2.2.1`, `2.2.2`. You can switch to different Magento versions very easily when testing extensions and themes. |
0 commit comments