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/

TL;DR;

Docker Compose

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-magento/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Why use Bitnami Images?

Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
With Bitnami images the latest bug fixes and features are available as soon as possible.
Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
Bitnami images are built on CircleCI and automatically pushed to the Docker Hub.
All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.

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'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MARIADB_USER=bn_magento
      - MARIADB_PASSWORD=your_password
      - MARIADB_DATABASE=bitnami_magento
    volumes:
      - 'mariadb_data:/bitnami'
  magento:
    image: 'bitnami/magento:latest'
    environment:
      - MARIADB_HOST=mariadb
      - MARIADB_PORT_NUMBER=3306
      - MAGENTO_DATABASE_USER=bn_magento
      - MAGENTO_DATABASE_PASSWORD=your_password
      - MAGENTO_DATABASE_NAME=bitnami_magento
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - 'magento_data:/bitnami'
    depends_on:
      - mariadb

volumes:
  mariadb_data:
    driver: local
  magento_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:

Create a new network for the application and the database:

$ docker network create magento-tier

Create a volume for MariaDB persistence and create a MariaDB container

$ docker volume create --name mariadb_data
$ docker run -d --name mariadb \
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MARIADB_USER=bn_magento \
  -e MARIADB_PASSWORD=your_password \
  -e MARIADB_DATABASE=bitnami_magento \
  --net magento-tier \
  --volume mariadb_data:/bitnami \
  bitnami/mariadb:latest

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

Create volumes for Magento persistence and launch the container

$ docker volume create --name magento_data
$ docker run -d --name magento -p 80:80 -p 443:443 \
  -e MAGENTO_DATABASE_USER=bn_magento \
  -e MAGENTO_DATABASE_PASSWORD=your_password \
  -e MAGENTO_DATABASE_NAME=bitnami_magento \
  --net magento-tier \
  --volume magento_data:/bitnami \
  bitnami/magento:latest

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 the container all your data and configurations will be lost, and the next time you run the image the database 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 you should mount a volume at the /bitnami path. Additionally you should mount a volume for persistence of the MariaDB data.

The above examples define docker volumes namely mariadb_data and magento_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. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

This requires a minor change to the docker-compose.yml template previously shown:

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
      - MARIADB_USER=bn_magento
      - MARIADB_PASSWORD=your_password
      - MARIADB_DATABASE=bitnami_magento
    volumes:
      - /path/to/mariadb-persistence:/bitnami
  magento:
    image: 'bitnami/magento:latest'
    environment:
      - MARIADB_HOST=mariadb
      - MARIADB_PORT_NUMBER=3306
      - MAGENTO_DATABASE_USER=bn_magento
      - MAGENTO_DATABASE_PASSWORD=your_password
      - MAGENTO_DATABASE_NAME=bitnami_magento
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - '/path/to/magento-persistence:/bitnami'

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:

Create a network (if it does not exist):

$ docker network create magento-tier

Create a MariaDB container with host volume:

$ docker run -d --name mariadb
  -e ALLOW_EMPTY_PASSWORD=yes \
  -e MARIADB_USER=bn_magento \
  -e MARIADB_PASSWORD=your_password \
  -e MARIADB_DATABASE=bitnami_magento \
  --net magento-tier \
  --volume /path/to/mariadb-persistence:/bitnami \
  bitnami/mariadb:latest

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

Create the Magento container with host volumes:

$ docker run -d --name magento -p 80:80 -p 443:443 \
  -e MAGENTO_DATABASE_USER=bn_magento \
  -e MAGENTO_DATABASE_PASSWORD=your_password \
  -e MAGENTO_DATABASE_NAME=bitnami_magento \
  --net magento-tier \
  --volume /path/to/magento-persistence:/bitnami \
  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

Get the updated images:

$ docker pull bitnami/magento:latest

Stop your container

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

Take a snapshot of the application state

$ rsync -a /path/to/magento-persistence /path/to/magento-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

Additionally, snapshot the MariaDB data

You can use these snapshots to restore the application state should the upgrade fail.

Remove the currently running container

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

Run the new image

For docker-compose: $ docker-compose start magento
For manual execution (mount 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:

magento:
  image: bitnami/magento:latest
  ports:
    - 80:80
    - 443:443
  environment:
    - MAGENTO_PASSWORD=my_password1234

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

$ docker run -d --name magento -p 80:80 -p 443:443 \
  -e MAGENTO_PASSWORD=my_password1234 \
  --net magento-tier \
  --volume /path/to/magento-persistence:/bitnami \
  bitnami/magento:latest

Available variables:

User and Site configuration

MAGENTO_USERNAME: Magento application username. Default: user
MAGENTO_PASSWORD: Magento application password. Default: bitnami1
MAGENTO_EMAIL: Magento application email. Default: [email protected]
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

Database configuration

There are two options to configure the Magento database. You can either use an existing database or create a new one from the Magento container using the mysql client. Below you can see the available environment variables for each option:

Use an existing database

MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306
MAGENTO_DATABASE_NAME: Database name that Magento will use to connect with the database. Default: bitnami_magento
MAGENTO_DATABASE_USER: Database user that Magento will use to connect with the database. Default: bn_magento
MAGENTO_DATABASE_PASSWORD: Database password that Magento will use to connect with the database. No defaults. Required.
ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

Create a database for Magento using mysql-client

MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306
MARIADB_ROOT_USER: Database admin user. Default: root
MARIADB_ROOT_PASSWORD: Database password for the MARIADB_ROOT_USER user. No defaults.
MYSQL_CLIENT_CREATE_DATABASE_NAME: New database to be created by the mysql client module. No defaults.
MYSQL_CLIENT_CREATE_DATABASE_USER: New database user to be created by the mysql client module. No defaults.
MYSQL_CLIENT_CREATE_DATABASE_PASSWORD: Database password for the MYSQL_CLIENT_CREATE_DATABASE_USER user. No defaults.
MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES: Comma-separated list of privileges to grant to the database user. Default: ALL
ALLOW_EMPTY_PASSWORD: It can be used to allow blank passwords. Default: no

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. 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

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.

f3r / bitnami-docker-magento Goto Github PK

bitnami-docker-magento's Introduction