OroCommerce|OroCRM|OroPlatform Docker Environment

Supported Systems

• MacOs (Intel, Apple Silicon)
• Linux (AMD64, ARM64)
• Windows via WSL2 (AMD64)

Pre-requirements

Docker

MacOs
Install Docker for Mac: https://docs.docker.com/desktop/mac/install/

Linux (Ubuntu and others)
Install Docker Engine: https://docs.docker.com/engine/install/ubuntu/
Install Docker Compose https://docs.docker.com/compose/install/compose-plugin/

Windows
Follow this guide: https://docs.docker.com/desktop/windows/wsl/

Homebrew (MacOs/Linux/Windows)

Install Homebrew by following guide https://docs.brew.sh/Installation

Configure Composer Credentials

You need to export following variable or add it to the .bashrc or .zshrc file

export COMPOSE_PROJECT_COMPOSER_AUTH='{
    "http-basic": {
        "repo.example.com": {
            "username": "xxxxxxxxxxxx",
            "password": "yyyyyyyyyyyy"
        }
    },
    "github-oauth": {
        "github.com": "xxxxxxxxxxxx"
    },
    "gitlab-token": {
        "example.org": "xxxxxxxxxxxx"
    }
}'

To get the command from local machine use following command:

echo "export COMPOSE_PROJECT_COMPOSER_AUTH='"$(cat $(php -d display_errors=0 $(which composer) config --no-interaction --global home 2>/dev/null)/auth.json)"'"

Installation

Install via homebrew by following command

brew install digitalspacestdio/docker-compose-oroplatform/docker-compose-oroplatform

Usage

1. Clone the application source code

git clone --single-branch --branch 5.1.1 https://github.com/oroinc/orocommerce-application.git ~/orocommerce-application

2. Navigate to the directory

cd ~/orocommerce-application

3. Build docker images

docker-compose-oroplatform build

4. Install composer dependencies

docker-compose-oroplatform composer install -o --no-interaction

5. Optionally: Change the database driver in the config/parameters.yml (or .env-app) file.

example: ORO_DB_URL=postgres://application:application@database:5432/application?sslmode=disable&charset=utf8&serverVersion=13.7

7. Install the application by following command

docker-compose-oroplatform bin/console --env=prod --timeout=1800 oro:install --language=en --formatting-code=en_US --organization-name='Acme Inc.' --user-name=admin [email protected] --user-firstname=John --user-lastname=Doe --user-password='$ecretPassw0rd' --application-url='http://localhost:30180/' --sample-data=y

7. Optional: import database dump (supports *.sql and *.sql.gz files)

docker-compose-oroplatform import-database /path/to/dump.sql.gz

8. Warmup cache

docker-compose-oroplatform bin/console cache:warmup

9. Start the stack in the background mode

docker-compose-oroplatform up -d

Application should be available by following link: http://localhost:30180/

Shutdown the project stack

Stop containers

docker-compose-oroplatform down

Destroy containers and persistent data

docker-compose-oroplatform down -v

Extra tools

Connecting to the cli container

docker-compose-oroplatform bash

Generate compose config and run directly without this tool

docker-compose-oroplatform config > docker-compose.yml

docker compose up

Environment Variables

Can be stored in the .dockenv, .dockerenv or .env file in the project root

• COMPOSE_PROJECT_MODE - (mutagen|default)
• COMPOSE_PROJECT_COMPOSER_VERSION - (1|2 )
• COMPOSE_PROJECT_PHP_VERSION - (7.4|8.0|8.1|8.2), the image will be built from a corresponding fpm-alpine image, see https://hub.docker.com/_/php/?tab=tags&page=1&name=fpm-alpine&ordering=name for more versions
• COMPOSE_PROJECT_NODE_VERSION - (12|14|16) the image will be built from a corresponding alpine image, see https://hub.docker.com/_/node/tags?page=1&name=alpine3.16 for more versions
• COMPOSE_PROJECT_MYSQL_IMAGE - mysql:8.0-oracle see https://hub.docker.com/_/mysql/?tab=tags for more versions
• COMPOSE_PROJECT_PGSQL_VERSION - 13.8 see https://hub.docker.com/_/postgres/?tab=tags for more versions
• COMPOSE_PROJECT_ELASTICSEARCH_VERSION - 7.10.2 see https://www.docker.elastic.co/r/elasticsearch/elasticsearch-oss for more versions
• COMPOSE_PROJECT_NAME - by default the working directory name will be used
• COMPOSE_PROJECT_PORT_PREFIX - 302 by default

Custom Database Credentials

• COMPOSE_PROJECT_DATABASE_USER="custom"
• COMPOSE_PROJECT_DATABASE_PASSWORD="custom"
• COMPOSE_PROJECT_DATABASE_NAME="custom"