Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/meanbee/docker-magento

🐳 Docker containers with all required Magento dependencies installed available as Apache and CLI
https://github.com/meanbee/docker-magento

docker-image magento php7

Last synced: 4 days ago
JSON representation

🐳 Docker containers with all required Magento dependencies installed available as Apache and CLI

Host: GitHub
URL: https://github.com/meanbee/docker-magento
Owner: meanbee
License: mit
Archived: true
Created: 2015-10-30T13:28:13.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2023-07-21T20:28:44.000Z (over 1 year ago)
Last Synced: 2024-08-02T05:15:10.064Z (3 months ago)
Topics: docker-image, magento, php7
Language: Dockerfile
Homepage:
Size: 152 KB
Stars: 68
Watchers: 8
Forks: 40
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # meanbee/magento

[![Build Status][ico-travis]][link-travis]

[![Docker Build Status][ico-dockerbuild]][link-dockerhub]

[![Docker Pulls][ico-downloads]][link-dockerhub]

[![Docker Stars][ico-dockerstars]][link-dockerhub]

A collection of Docker images for running Magento application web servers and command line tools.

# Supported tags and respective `Dockerfile` links

- [`7.4-apache` (*7.4/apache/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.4/apache/Dockerfile)

- [`7.4-cli` (*7.4/cli/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.4/cli/Dockerfile)

- [`7.4-fpm` (*7.4/fpm/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.4/fpm/Dockerfile)

- [`7.3-apache` (*7.3/apache/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.3/apache/Dockerfile)

- [`7.3-cli` (*7.3/cli/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.3/cli/Dockerfile)

- [`7.3-fpm` (*7.3/fpm/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.3/fpm/Dockerfile)

- [`7.2-apache` (*7.2/apache/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.2/apache/Dockerfile)

- [`7.2-cli` (*7.2/cli/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.2/cli/Dockerfile)

- [`7.2-fpm` (*7.2/fpm/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.2/fpm/Dockerfile)

- [`7.1-apache` (*7.1/apache/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.1/apache/Dockerfile)

- [`7.1-cli` (*7.1/cli/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.1/cli/Dockerfile)

- [`7.1-fpm` (*7.1/fpm/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.1/fpm/Dockerfile)

- [`7.0-apache` (*7.0/apache/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.0/apache/Dockerfile)

- [`7.0-cli` (*7.0/cli/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.0/cli/Dockerfile)

- [`7.0-fpm` (*7.0/fpm/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/7.0/fpm/Dockerfile)

- [`5.6-apache` (*5.6/apache/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/5.6/apache/Dockerfile)

- [`5.6-cli` (*5.6/cli/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/5.6/cli/Dockerfile)

- [`5.6-fpm` (*5.6/fpm/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/5.6/fpm/Dockerfile)

- [`5.5-apache` (*5.5/apache/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/5.5/apache/Dockerfile)

- [`5.5-cli` (*5.5/cli/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/5.5/cli/Dockerfile)

- [`5.5-fpm` (*5.5/fpm/Dockerfile*)](https://github.com/meanbee/docker-magento/blob/master/5.5/fpm/Dockerfile)

# Usage

Since Magento requires several services working together, it recommended to use docker-compose with these images.

See [docker-compose.yml](docker-compose.yml) for a sample configuration.

# Options

## Sendmail

All images have sendmail installed for emails, however it is not enabled by default. To enable sendmail, use the following environment variable:

    ENABLE_SENDMAIL=true

*Note:* If sendmail has been enabled, make sure the container has a hostname assigned using the `hostname` field in `docker-compose.yml` or `--hostname` parameter for `docker run`. If the container does not have a hostname set, sendmail will attempt to discover the hostname on startup, blocking for a prolonged period of time.

## Xdebug

Xdebug is installed and enabled on all the images by default. To configure it for remote debugging, start

the container with the following environment variable set (replacing the `{}` placeholders with appropriate values):

    XDEBUG_CONFIG="remote_connect_back=1 remote_enable=1 idekey={IDEKEY}"

Note: If you're using PhpStorm, your IDE Key is probably `phpstorm`.

# Command Line Tools

The `cli` images have a number of useful Magento tools pre-installed:

- [composer](https://getcomposer.org/) - Install and manage PHP package dependencies

- [mageconfigsync](https://github.com/punkstar/mageconfigsync) - Backup and restore Magento System Configuration

- [magedbm](https://github.com/meanbee/magedbm) - Create development backups of the Magento database using S3 and import them

- magemm - Sync media images from an S3 backup

- [modman](https://github.com/colinmollenhour/modman) - Install Magento extensions

- [magerun](https://github.com/netz98/n98-magerun) - Run command line commands in Magento

All of the installed tools run in the working directory of the container, so don't forget to set it using the `working_dir` service configuration option in `docker-compose.yml` or the `--workdir` parameter to `docker run`.

Some of the commands use additional environment variables for configuration:

 - `AWS_ACCESS_KEY_ID` _(magedbm, magemm)_ Credentials for S3 connections

 - `AWS_SECRET_ACCESS_KEY` _(magedbm, magemm)_ Credentials for S3 connections

 - `AWS_REGION` _(magedbm, magemm)_ S3 region to use

 - `AWS_BUCKET` _(magedbm)_ S3 bucket to use for database backups

 - `AWS_MEDIA_BUCKET` _(magemm)_ S3 bucket to fetch media images from

# Building

A lot of the configuration for each image is the same, with the difference being the base image that they're extending from.  For this reason we use `php` to build the `Dockerfile` from a set of templates in `src/`.  The `Dockerfile` should still be published to the repository due to Docker Hub needing a `Dockerfile` to build from.

To build all `Dockerfile`s, run the `builder.php` script in the `php:7` Docker image:

    docker run --rm -it -v $(pwd):/src php:7 php /src/builder.php

## Adding new images to the build config

The build configuration is controlled by the `config.json` file. Yeah element in the top level hash is a new build target, using the following syntax:

    "": {

        "version": "",

        "flavour": "",

        "files": {

            "": {

                "": "",

                ...

            },

    }

The target files will be rendered in the `//` directory.

The source template for each target file is selected from the `src/` directory using the following fallback order:

1. `--`

2. `-`

3. `-`

4. ``

Individual templates may include other templates as partials.

[ico-travis]: https://img.shields.io/travis/meanbee/docker-magento.svg?style=flat-square

[ico-dockerbuild]: https://img.shields.io/docker/build/meanbee/magento.svg?style=flat-square

[ico-downloads]: https://img.shields.io/docker/pulls/meanbee/magento.svg?style=flat-square

[ico-dockerstars]: https://img.shields.io/docker/stars/meanbee/magento.svg?style=flat-square

[link-travis]: https://travis-ci.org/meanbee/docker-magento

[link-dockerhub]: https://hub.docker.com/r/meanbee/magento/