https://github.com/julienloizelet/docker-magento1
[DEPRECATED] Docker and docker-compose for an already existant project On Magento 1.✕
https://github.com/julienloizelet/docker-magento1
docker docker-compose magento magento-1
Last synced: 3 months ago
JSON representation
[DEPRECATED] Docker and docker-compose for an already existant project On Magento 1.✕
- Host: GitHub
- URL: https://github.com/julienloizelet/docker-magento1
- Owner: julienloizelet
- License: bsd-3-clause
- Created: 2017-09-19T13:36:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-17T09:34:51.000Z (almost 5 years ago)
- Last Synced: 2025-01-14T13:33:21.395Z (4 months ago)
- Topics: docker, docker-compose, magento, magento-1
- Language: Dockerfile
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECATED
> This is no longer supported, please consider using [https://github.com/julienloizelet/docker-openmage](https://github.com/julienloizelet/docker-openmage) instead.
> Use it to manage a Magento 1 project with docker and docker-compose.
By "already existant project On Magento 1.✕", I mean a project based on Magento 1.✕ version (community or enterprise) for which you have sources and database.
Originally forked from [andreaskoch/dockerized-magento](https://github.com/andreaskoch/dockerized-magento).
## Installing / Getting started
### Requirements
If you are on Linux you should install
- [docker](http://docs.docker.com/compose/install/#install-docker) and
- [docker-compose](http://docs.docker.com/compose/install/#install-compose)
If you are running on [Mac OS](https://docs.docker.com/engine/installation/mac/) or [Windows](https://docs.docker.com/engine/installation/windows/) you can install the [Docker Toolbox](https://docs.docker.com/engine/installation/mac/) which contains docker, docker-compose and docker-machine.
The web-server will be bound to your local ports 80 and 443. In order to access the shop you must add a hosts file entry for `yourdomainname.local`.
### Add the domain name
For Linux Users, in order to access the shop you must add the domain name "yourdomainname.local" to your hosts file (`/etc/hosts`).
If you are using docker **natively** you can use this command:
```bash
sudo su
echo "127.0.0.1 yourdomainname.local" >> /etc/hosts
```
### Get your sources ready
We will assume sources are in a directory called `/some/path/for/your-project-sources`.
For example, my own is `/home/julien/workspace/name-of-a-project`
### Get your database ready
Copy a dump `yourdatabasedump.sql` in the path `data/dump`.
If you don't have an existent database, you can do a classic Magento installation. For
that purpose you should follow the above Installation instructions but skip the Post Installation instructions :do not create the `local.xml` file and go to the url `http://yourdomainname.local` in your favorite browser.
### Installation
1. Make sure you have docker and docker-compose on your system
2. Clone the repository `git clone https://github.com/julienloizelet/docker-magento1.git`
3. Create a `docker-compose.override.yml` from the example `docker-compose.override.yml.dist` and make the necessary changes. (e.g replace `/some/path/for/your-project-sources` depending on your own and remove comments.)
4. If some program are listening to port 80 or 443 (e.g apache or nginx), you must stop them. (`sudo service apache2 stop`)
5. Start the projects using `sudo ./magento start` (maybe you will have to do a `chmod +x magento`).
6. (optional) If you get error messages like "permission denied", you should run `sudo chmod -R 777 bin` and then rerun `sudo ./magento start`.
During the first start of the project **docker-compose** will
1. first **build** all docker-images referenced in the [docker-compose.yml](docker-compose.yml)
2. then **start** the containers
3. and **trigger the installer**
Once the installation is finished the installer will print the URL and the credentials for the backend to the installer log:
```
...
installer_1 | phpMyAdmin: http://yourdomainname.local:8081
installer_1 | - Username: root
installer_1 | - Password: pw
installer_1 |
installer_1 |
installer_1 | Mail dev: http://yourdomainname.local:8282
installer_1 |
installer_1 |
installer_1 | Frontend: http://yourdomainname.local/
```
**Note**: The build process and the installation process will take a while if you start the project for the first time. After that, starting and stoping the project will be a matter of seconds.
## Post Installation
### Import the database
1. Create a `yourdatabase` database (a simple way is to use `phpmyadmin` by going to the url : `http://localhost:8081`)
2. We will the import the database with the following commands (use `pw` as root password when prompted.):
```sudo ./magento enter mysql
cd /etc/dump
mysql -u root -h localhost -p yourdatabase < yourdatabase.sql
```
### Modify the `app/etc/local.xml` file
Go to the `/some/path/for/magento/sources` and edit the `app/etc/local.xml` file with the following content (replace `yourdatabase` name by yours):
```
false
1
db
redissession
7
6379
2.5
0
2048
gzip
1
6
5
30
7200
0
Mage_Cache_Backend_Redis
rediscache
6379
0
0
1
10
0
1
1
20480
gzip
0
```
## Usage
You can control the project using the built-in `magento`-script which is basically just a **wrapper for docker and docker-compose** that offers some **convenience features**:
```bash
./magento
```
**Available Actons**
- **start**: Starts the docker containers (and triggers the installation if magento is not yet installed)
- **stop**: Stops all docker containers
- **restart**: Restarts all docker containers and flushes the cache
- **status**: Prints the status of all docker containers
- **stats**: Displays live resource usage statistics of all containers
- **magerun**: Executes magerun in the magento root directory
- **composer**: Executes composer in the magento root directory
- **enter**: Enters the bash of a given container type (e.g. php, mysql, ...)
- **destroy**: Stops all containers and removes all data
**Note**: The `magento`-script is just a small wrapper around `docker-compose`. You can just use [docker-compose](https://docs.docker.com/compose/) directly.
## Components
### Overview
The dockerized Magento project consists of the following components:
- **[docker images](docker-images)**
1. a [PHP 5.5](docker-images/php/Dockerfile) image
1. a [Nginx]() image
1. a standard [MySQL](https://hub.docker.com/_/mysql/) database server image
1. multiple instances of the standard [Redis](https://hub.docker.com/_/redis/) docker image
1. a standard [phpMyAdmin](https://hub.docker.com/r/phpmyadmin/phpmyadmin/) image that allows you to access the database on port 8080
1. a Maildev image to prevent sending email on test environnment.
1. and a [Installer](docker-images/installer/Dockerfile) image which contains all tools for installing the project from scratch using an [install script](docker-images/installer/bin/install.sh)
- a **[shell script](magento)** for controlling the project: [`./magento `](magento)
- and the [docker-compose.yml](docker-compose.yml)-file which connects all components
If you are interested in a **guide on how to dockerize a Magento** shop yourself you can have a look at a blog-post of Andreas Koch: [Dockerizing Magento](https://andykdocs.de/development/Docker/Dockerize-Magento) on [AndyK Docs](https://andykdocs.de)
## Custom Configuration
All parameters of the Magento installation are defined via environment variables that are set in the [docker-compose.yml](docker-compose.yml) file - if you want to tailor the Magento Shop installation to your needs you can do so **by modifying the environment variables** before you start the project.
If you have started the shop before you must **repeat the installation process** in order to apply changes:
1. Modify the parameters in the `docker-compose.yml`
2. Shutdown the containers and remove all data (`sudo ./magento destroy`)
3. Start the containers again (`sudo ./magento start`)
### Changing the domain name
I set the default domain name to `yourdomainname.local`. To change the domain name replace `yourdomainname.local` with `your-domain.tld` in the `docker-compose.yml` file:
```yaml
installer:
environment:
DOMAIN: yourdomainname.local
```
### Change the MySQL Root User Password
I chose a very weak passwords for the MySQL root-user. You can change it by modifying the respective environment variables for the **mysql-container** ... and **installer** because otherwise the installation will fail:
```yaml
installer:
environment:
MYSQL_PASSWORD:
mysql:
environment:
MYSQL_ROOT_PASSWORD:
```
## Working with X-debug and Phpstorm
Here is what I am doing to configure X-debug on Phpstorm (tested on 2016.2.2 version)
1. First get the IP to put in your `docker-compose-override.yml` with a `ifconfig` command. (I obtain something like 10.1.156.27).
2. Install and configure a plugin for Firefox : (i use [The easiest Xdebug](https://addons.mozilla.org/en-US/firefox/addon/the-easiest-xdebug/))
Go to Tools->Addons->Extensions->The easiest Xdebug and change your IDE-key : `phpstorm-xdebug`.
3. Configure Phpstorm :
- Settings -> Languages and Frameworks -> PHP -> Debug -> Set the port (9000 for me)
- Project Settings (where are the Magento sources) -> PHP -> Servers : Add server configuration of your site (`host = yourdomainname.local`)
and add the path mapping `/some/path/for/your-project-sources` to `/var/www/html/web`
- Go to Run->Edit configurations. Add "PHP Remote Debug" configuration, select your server (that you just added) and enter an IDE-key : `phpstorm-xdebug`.
- Select Run->Debug... and select your remote configuration name (as you named it above)
## Working with my [Magento 1 installation based on composer](https://github.com/julienloizelet/composer-magento1.git)
If you are using composer with a repo like [mine](https://github.com/julienloizelet/composer-magento1.git) (i.e if you are me ...), beware that you have to create the `docker-compose.override.yml` with some specific volumes (see the `docker-compose.override.yml.dist` file).
You will then be able to run your composer commands once you will be in the `php` container :
- On a fresh install : run the following commands :
- `sudo ./magento start`.
- `sudo ./magento enter php7`
- `composer install`
- As the `htdocs` folder is created at this moment, we have to restart container in order to have a functional volume (i.e a link between `htdocs` and `/var/www/html/web`).
So, just run `sudo ./magento destroy` and then `sudo ./magento start` again.
## Troubleshooting
- On first `sudo ./magento start`, you may have an error :
`for nginx Cannot start service nginx: oci runtime error: container_linux.go:247: starting container process caused "exec: \"/bin/nginx.sh\": permission denied"`
Workaround : before launch it again : `sudo chmod -R 777 bin`
- On first `sudo ./magento start`, you may have an error : `magento1_installer | /bin/install.sh: line ... Text file busy`
Workaround : `sudo ./magento stop` then `sudo ./magento start`
## Contributing
If you'd like to contribute, please fork the repository and use a feature
branch. Pull requests are warmly welcome.
If you found any issue, please go [there](https://github.com/julienloizelet/docker-magento1/issues).
## Licensing
The code in this project is licensed under BSD 3-clause license.