[![CircleCI](https://circleci.com/gh/bitnami/bitnami-docker-magento/tree/master.svg?style=shield)](https://circleci.com/gh/bitnami/bitnami-docker-magento/tree/master)
[![Docker Hub Automated Build](http://container.checkforupdates.com/badges/bitnami/magento)](https://hub.docker.com/r/bitnami/magento/)

# What is Magento?

> Magento is a feature-rich flexible e-commerce solution. It includes transaction options, multi-store functionality, loyalty programs, product categorization and shopper filtering, promotion rules, and more.

https://magento.com/

# Prerequisites

To run this application you need Docker Engine 1.10.0. Docker Compose is recomended with a version 1.6.0 or later.

# How to use this image

## Run Magento with a Database Container

Running Magento with a database server is the recommended way. You can either use docker-compose or run the containers manually.

### Run the application using Docker Compose

This is the recommended way to run Magento. You can use the following docker compose template:

```
version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    volumes:
      - 'mariadb_data:/bitnami/mariadb'
  application:
    image: 'bitnami/magento:latest'
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - 'magento_data:/bitnami/magento'
      - 'php_data:/bitnami/php'
      - 'apache_data:/bitnami/apache'
    depends_on:
      - mariadb

volumes:
  mariadb_data:
    driver: local
  magento_data:
    driver: local
  apache_data:
    driver: local
  php_data:
    driver: local
```

### Run the application manually

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

1. Create a new network for the application and the database:

  ```
  $ docker network create magento_network
  ```

2. Start a MariaDB database in the network generated:

  ```
  $ docker run -d --name mariadb --net=magento_network bitnami/mariadb
  ```

  *Note:* You need to give the container a name in order to Magento to resolve the host

3. Run the Magento container:

  ```
  $ docker run -d -p 80:80 --name magento --net=magento_network bitnami/magento
  ```

Then you can access your application at http://your-ip/

*Note:* If you want to access your application from a public IP or hostname you need to configure the application domain. You can handle it adjusting the configuration of the instance by setting the environment variable "MAGENTO_HOST" to your public IP or hostname.

## Persisting your application

If you remove every container and volume all your data will be lost, and the next time you run the image the application will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed. 

For persistence of the Magento deployment, the above examples define docker volumes namely `mariadb_data`, `magento_data`, `apache_data` and `php_data`. The Magento application state will persist as long as these volumes are not removed.

To avoid inadvertent removal of these volumes you can [mount host directories as data volumes](https://docs.docker.com/engine/tutorials/dockervolumes/). Alternatively you can make use of volume plugins to host the volume data.

> **Note!** If you have already started using your application, follow the steps on [backing](#backing-up-your-application) up to pull the data from your running container down to your host.

### Mount host directories as data volumes with Docker Compose

TThis requires a minor change to the `docker-compose.yml` template previously shown:
```
version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    volumes:
      - '/path/to/mariadb_data:/bitnami/mariadb'
  magento:
    image: 'bitnami/magento:latest'
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - '/path/to/magento-persistence:/bitnami/magento'
      - '/path/to/php-persistence:/bitnami/php'
      - '/path/to/apache-persistence:/bitnami/apache'
    
```

### Mount host directories as data volumes using the Docker command line

In this case you need to specify the directories to mount on the run command. The process is the same than the one previously shown:

1. Create a network (if it does not exist):

  ```
  $ docker network create magento-tier
  ```

2. Create a MariaDB container with host volume:

  ```
  $ docker run -d --name mariadb \
    --net magento-tier \
    --volume /path/to/mariadb-persistence:/bitnami/mariadb \
    bitnami/mariadb:latest
  ```

  *Note:* You need to give the container a name in order to Magento to resolve the host

3. Create the Magento container with host volumes:

  ```
  $ docker run -d --name magento -p 80:80 -p 443:443 \
    --net magento-tier \
    --volume /path/to/magento-persistence:/bitnami/magento \
    --volume /path/to/apache-persistence:/bitnami/apache \
    --volume /path/to/php-persistence:/bitnami/php \
    bitnami/magento:latest
  ```

# Upgrade this application

Bitnami provides up-to-date versions of MariaDB and Magento, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Magento container. For the MariaDB upgrade see https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image

1. Get the updated images:

  ```
  $ docker pull bitnami/magento:latest
  ```

2. Stop your container

 * For docker-compose: `$ docker-compose stop magento`
 * For manual execution: `$ docker stop magento`

3. (For non-compose execution only) Create a [backup](#backing-up-your-application) if you have not mounted the magento folder in the host.

4. Remove the currently running container

 * For docker-compose: `$ docker-compose rm -v magento`
 * For manual execution: `$ docker rm -v magento`

5. Run the new image

 * For docker-compose: `$ docker-compose start magento`
 * For manual execution ([mount](#mount-persistent-folders-manually) the directories if needed): `docker run --name magento bitnami/magento:latest`

# Configuration
## Environment variables
 When you start the magento image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

 * For docker-compose add the variable name and value under the application section:
```
application:
  image: bitnami/magento:latest
  ports:
    - 80:80
  environment:
    - MAGENTO_PASSWORD=my_password1234
  volumes_from:
    - application_data
```

 * For manual execution add a `-e` option with each variable and value:

```
 $ docker run -d -e MAGENTO_PASSWORD=my_password1234 -p 80:80 --name magento -v /your/local/path/bitnami/magento:/bitnami/magento --net=magento_network bitnami/magento
```

Available variables:

 - `MAGENTO_USERNAME`: Magento application username. Default: **user**
 - `MAGENTO_PASSWORD`: Magento application password. Default: **bitnami1**
 - `MAGENTO_EMAIL`: Magento application email. Default: **user@example.com**
 - `MAGENTO_ADMINURI`: Prefix to access the Magento Admin. Default: **admin**
 - `MAGENTO_FIRSTNAME`: Magento application first name. Default: **FirstName**
 - `MAGENTO_LASTNAME`: Magento application last name. Default: **LastName**
 - `MAGENTO_HOST`: Host domain or IP.
 - `MAGENTO_MODE`: Magento mode. Valid values: **default**, **production**, **developer**. Default: **default**
 - `MARIADB_USER`: Root user for the MariaDB database. Default: **root**
 - `MARIADB_PASSWORD`: Root password for the MariaDB.
 - `MARIADB_HOST`: Hostname for MariaDB server. Default: **mariadb**
 - `MARIADB_PORT`: Port used by MariaDB server. Default: **3306**

# Backing up your application

To backup your application data follow these steps:

1. Stop the running container:

  * For docker-compose: `$ docker-compose stop magento`
  * For manual execution: `$ docker stop magento`

2. Copy the Magento data folder in the host:

  ```
  $ docker cp /your/local/path/bitnami:/bitnami/magento
  ```

# Restoring a backup

To restore your application using backed up data simply mount the folder with Magento data in the container. See [persisting your application](#persisting-your-application) section for more info.

# Contributing

We'd love for you to contribute to this container. You can request new features by creating an
[issue](https://github.com/bitnami/bitnami-docker-magento/issues), or submit a
[pull request](https://github.com/bitnami/bitnami-docker-magento/pulls) with your contribution.

# Issues

If you encountered a problem running this container, you can file an
[issue](https://github.com/bitnami/bitnami-docker-magento/issues). For us to provide better support,
be sure to include the following information in your issue:

- Host OS and version
- Docker version (`docker version`)
- Output of `docker info`
- Version of this container (`echo $BITNAMI_IMAGE_VERSION` inside the container)
- The command you used to run the container, and any relevant output you saw (masking any sensitive
information)

# License

Copyright (c) 2016 Bitnami

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.