https://github.com/faradey/madock
Local development environment based on Docker
https://github.com/faradey/madock
docker local-development magento magento2
Last synced: 5 months ago
JSON representation
Local development environment based on Docker
- Host: GitHub
- URL: https://github.com/faradey/madock
- Owner: faradey
- License: mit
- Created: 2021-09-15T19:29:03.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2026-01-19T16:36:43.000Z (5 months ago)
- Last Synced: 2026-01-19T22:49:47.073Z (5 months ago)
- Topics: docker, local-development, magento, magento2
- Language: Go
- Homepage:
- Size: 3.25 MB
- Stars: 32
- Watchers: 4
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# madock
Local development environment based on Docker
Supported platforms: Magento2, PWA, Shopify, Shopware, Custom PHP projects.
[](https://godoc.org/github.com/faradey/madock)
[](https://goreportcard.com/report/github.com/faradey/madock)
[](https://github.com/faradey/madock/releases)
[](https://opensource.org/license/mit/)
[](https://github.com/faradey/madock/issues)
## Description
`madock` is a local Docker-based environment that allows you to run PHP projects.
This project is written on Golang, and it is distributed under a MIT License.
## Key Features
* Automatic project setup
* Two or more projects can work simultaneously
* **Magento** as a separate service. Works by default. Learn [more](docs/magento.md)
* **PWA Studio** as a separate service
* **Shopify** as a separate service. Learn [more](docs/shopify.md)
* **Custom PHP project** as a separate service
* **Shopware** as a separate service. Learn [more](docs/shopware.md)
* **PrestaShop** as a separate service. Learn [more](docs/prestashop.md)
* Cron support
* Flexible configuration for each project
* Database import and export in two clicks
* Simple viewing of logs with one command
* Debug support
* Synchronization of the local database and media files with the dev site
* Additional services: phpmyadmin, redis, rabbitMQ, elasticsearch, Kibana, ioncube, xdebug, cron
* LiveReload. Learn [more](docs/livereload.md)
* Mailpit (email testing tool for developers)
* Magento Cloud
* Composer patches in two clicks
* Magento Functional Testing Framework (MFTF). Learn [more](docs/mftf.md)
* Scopes. Learn [more](docs/scopes.md)
* Configuration in a project. Learn [more](docs/config.md)
* Snapshots. Learn [more](docs/snapshot.md)
* Isolation mode [more](docs/isolation.md)
* Varnish Cache [more](docs/varnish.md)
* Custom commands [more](docs/custom_commands.md)
## Tested on
* Linux (Ubuntu 20.04)
* macOS (Monterey, Sonoma)
* Windows (10, 11)
## Video
[](https://www.youtube.com/watch?v=_9NvZak_kt8)
## Installation
You need 5 things on your local machine: `git`, `docker`, `docker-compose`, `golang` and `madock`
_The new version 2 is not backwards compatible with version 1.
If you have problems with version 2, you can use version 1.x temporarily as it is more stable.
Version 1 does not receive any more improvements.
To use version 1 you should switch to [master-1.x.x](https://github.com/faradey/madock/tree/master-1.x.x) branch_
Follow the installation steps for your system.
Mac
1. Install [Docker](https://docs.docker.com/docker-for-mac/install/)
2. Install [Golang](https://go.dev/doc/install)
3. Clone this repo and follow into folder "madock"
```
git clone git@github.com:faradey/madock.git
```
If you got error "git@github.com: Permission denied (publickey)." see [solution](https://docs.github.com/en/authentication/troubleshooting-ssh/error-permission-denied-publickey#verify-the-public-key-is-attached-to-your-account)
4. Go to the cloned directory
```shell
cd madock
```
5. Compile
```
Run command below for Apple M1
GOARCH=arm64 go build -o madock
```
```
Run command below for Apple Intel
go build -o madock
```
6. Add `madock` bin into your `$PATH`
```shell
Run command below for Apple M1
sudo ln -s absolute_path_to_your_madock_dir/madock /opt/homebrew/bin/
```
```shell
Run command below for Apple Intel
sudo ln -s absolute_path_to_your_madock_dir/madock /usr/local/bin/
```
7. Open a new terminal tab/window and check that `madock` works
```
which madock
madock
```
8. Optionally you can also apply these performance tweaks
* [http://markshust.com/2018/01/30/performance-tuning-docker-mac](http://markshust.com/2018/01/30/performance-tuning-docker-mac)
Linux
1. Install docker
* Install Docker on [Debian](https://docs.docker.com/engine/installation/linux/docker-ce/debian/)
* Install Docker on [Ubuntu](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/)
* Install Docker on [CentOS](https://docs.docker.com/engine/installation/linux/docker-ce/centos/)
2. Configure permissions
* [Manage Docker as a non-root user](https://docs.docker.com/install/linux/linux-postinstall/)
3. Install [Docker-compose](https://docs.docker.com/compose/install/)
4. Install [Golang](https://go.dev/doc/install)
5. Clone this repo and follow into folder "madock"
```
git clone git@github.com:faradey/madock.git
```
If you got error "git@github.com: Permission denied (publickey)." see [solution](https://docs.github.com/en/authentication/troubleshooting-ssh/error-permission-denied-publickey#verify-the-public-key-is-attached-to-your-account)
6. Compile
```
go build -o madock
```
7. Add `madock` bin into your `$PATH`
```
ln -s absolute_path_to_your_madock_dir/madock /usr/local/bin/
```
8. Open a new terminal tab/window and check that `madock` works
```
which madock
madock
```
## Project Setup
```shell
cd
madock setup --download --install # for a new empty project with the clean Magento
madock setup # for an existing project
```
## Usage
### Start Application
```
madock start
madock composer install
sudo vim /etc/hosts
// Add -> 127.0.0.1
```
### Workflow
See detailed documentation about development workflow with madock
IMPORTANT: Please, read all items before starting work.
* [Development Workflow](docs/workflow.md)
## More Documentation
* [Deployment Guide](docs/deployment-guide.md) (Setup existing projects on macOS, Linux, Windows)
* [JSON Output](docs/json_output.md)
* [VSCODE + Xdebug Setup](docs/xdebug_vscode.md)
* [PHPStorm + Xdebug Setup](docs/xdebug_phpstorm.md)
* [Docker images list](docs/docker_images.md)
* [Customizations](docs/customizations.md)
* [Database import, export, synchronization, phpmyadmin](docs/database.md)
* [Media synchronization](docs/media.md)
* [Cron](docs/cron.md)
* [ENV variables](docs/env.md)
* Kibana. URL http://{you_domain_name}/kibana
* Mailpit. Default URL http://localhost:8025
* [Store scopes](docs/store_scopes.md): website vs store
## Donations
If you find it useful and want to invite us for a beer, just click on the donation button. Thanks!
[](https://www.buymeacoffee.com/faradey)
## Resources
This project has been possible thanks to the following resources:
* [docker-magento](https://github.com/markoshust/docker-magento)
* [dockergento](https://github.com/ModestCoders/magento2-dockergento)
## License
* [The MIT License](https://opensource.org/licenses/MIT)
## Copyright
(c) faradey