Add SAMPLE_DATA option to dev/openmage/install.sh (#4602)

* Add SAMPLE_DATA option to dev/openmage/install.sh script and fix warnings.

* Improve reliability of waiting for MySQL to be ready

* Update docs

---------

Co-authored-by: Sven Reichel <[email protected]>

Author: colinmollenhour

dev/openmage/README.md

@@ -1,145 +1 @@
-OpenMage Stack
-===
-
-With these stack configuration files you can have a fully operational OpenMage LTS development in ONE step!
-Upgrade it to production with just a few more easy steps!
-
-**NOTE: Use at your own risk! No warrants or guarantees are provided as to the stability, security or general quality of these environment files.**
-
-For a more robust development environment that supports https, please consider using [ddev](https://ddev.readthedocs.io/en/stable/users/cli-usage/#magento-1-quickstart).
-
-## Prerequisites
-
-- Install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
-- Port 80 on your host must be unused. See [Environment Variables](#environment-variables) below if you need to use another port.
-- Clone the OpenMage LTS repo to your location of choice (`git clone https://github.com/OpenMage/magento-lts.git`).
-
-## Installation
-
-Run `dev/openmage/install.sh`. That's it!
-
-Visit [http://openmage-7f000001.nip.io/](http://openmage-7f000001.nip.io/) and start coding!
-
-Tips
-===
-
-See [colinmollenhour/docker-openmage](https://github.com/colinmollenhour/docker-openmage) for more information
-on the containers used in this setup, but here are some quick tips:
-
-- You can start the cron task using `docker-compose up -d cron`.
-- The `cli` service contains many useful tools like `composer`, `magerun`, `modman`, `mageconfigsync` and more.
-- XDebug is enabled using `remote_connect_back=1` with `idekey=phpstorm`. Customize this in `.env` if needed as described below.
-
-Here are some common commands you may wish to try (from the `dev/openmage` directory):
-
-```
-$ docker-compose run --rm -u $(id -u):$(id -g) cli composer show
-$ docker-compose run --rm -u $(id -u):$(id -g) cli bash
-$ docker-compose run --rm cli magerun sys:check
-$ docker-compose run --rm cli magerun cache:clean
-$ docker-compose run --rm cli magerun db:console
-$ docker-compose exec mysql mysql
-```
-
-- *The cli container runs as `www-data` by default so use `-u $(id -u):$(id -g)` with composer so that the container will create/modify files with your user permissions to avoid file permission errors in your IDE.*
-- *Always use `run --rm` with the cli container to avoid creating lots of orphan containers.*
-
-Environment Variables
----
-
-You can override some defaults using environment variables defined in a file (that you must create) at `dev/openmage/.env`.
-
-- `ENABLE_SENDMAIL=true` - Enable the sendmail MTA
-- `XDEBUG_CONFIG=...` - Override the default XDebug config
-- `HOST_NAME=your-preferred-hostname`
-  - `openmage-7f000001.nip.io` is used by default to resolve to `127.0.0.1`. See [nip.io](https://nip.io) for more info.
-- `HOST_PORT=8888`
-   - `80` is used by default 
-- `ADMIN_HOST_NAME`
-  - `openmage-admin-7f000001.nip.io` is used by default to resolve to `127.0.0.1`. See [nip.io](https://nip.io) for more info.
-- `ADMIN_HOST_PORT`
-  - `81` is used by default to avoid conflicts with the frontend port
-- `ADMIN_EMAIL`
-- `ADMIN_USERNAME`
-- `ADMIN_PASSWORD` (must be 14 characters or more)
-- `ADMIN_FIRSTNAME`
-- `ADMIN_LASTNAME`
-- `MAGE_IS_DEVELOPER_MODE`
-  - `1` is used by default, set to `0` to disable
-- `CURRENCY`
-  - `USD` is used by default
-- `LOCALE`
-  - `en-US` is used by default
-- `TIMEZONE`
-  - `America/New_York` is used by default
-- `MYSQL_PORT`
-  - `3306` is used by default
-- `PM_MAX_CHILDREN` - Tune to your environment and needs - see [PHP-FPM configuration](https://www.php.net/manual/en/install.fpm.configuration.php)
-- `PM_START_SERVERS`
-- `PM_MIN_SPARE_SERVERS`
-- `PM_MAX_SPARE_SERVERS`
-
-Wiping
----
-
-If you want to start fresh, wipe out your installation with the following command:
-
-```
-$ docker-compose down --volumes && rm -f ../../app/etc/local.xml
-```
-
-HTTPS / Production
-=====
-
-You can easily have a multi-store SSL-protected environment using Docker with the `docker-compose-production.yml` file.
-
-Features included out of the box:
-
-- Free and automatic SSL provided by [Caddy](https://caddyserver.com/docs/caddyfile)
-- Separate domains for frontend and admin sites
-- Examples included for redirects, Basic Auth, multi-store routing
-- Easily add routes to your other sites
-- Root static assets (e.g. robots.txt) in a separate directory for each store view 
-
-**Do not try to run a dev environment and a production environment from the same working copy!**
-
-If using OpenMage as a composer dependency, to avoid files being overwritten by composer upon updating OpenMage,
-it is recommended to copy the following files into your own project root and modify them as needed:
-
-- `dev/openmage/docker-compose-production.yml` --> `docker-compose.yml`
-- `dev/openmage/nginx-admin.conf` --> `nginx-admin.conf`
-- `dev/openmage/nginx-frontend.conf` --> `nginx-frontend.conf`
-- `dev/openmage/Caddyfile-sample` --> `Caddyfile`
-- `pub/admin/` --> `static/admin/`
-- `pub/default/{favicon.ico,robots.txt}` --> `static/default/`
-
-Then perform the following steps:
-
-1. `echo "COMPOSE_FILE=docker-compose-production.yml" >> .env` to make the production stack the default
-1. Add `BASE_URL` and `ADMIN_URL` to your `.env` file
-1. `cp Caddyfile-sample Caddyfile` and edit the `Caddyfile` to reflect your domain names and Magento store codes
-1. If you did not hard-code your admin domain name in `Caddyfile` edit `.env` and make sure it includes `ADMIN_HOST_NAME`
-1. Run `docker-compose up -d` to launch your new production-ready environment!
-1. Load your existing database into the MySQL container volume and copy an existing `local.xml` file into the `app/etc/` subdirectory of your OpenMage root (e.g. `pub/app/etc/local.xml` for composer installations with default `magento-root-dir`).
-   1. OR copy `dev/openmage/install.sh` into your root directory and run it to create a fresh installation.
-
-Environment variables supported by the `docker-compose-production.yml` file and `install.sh` which may be set in `.env`
-when installing a new production environment:
-
-- `SRC_DIR=./pub` - relative path to the OpenMage root - corresponds to the composer `magento-root-dir`
-- `STATIC_DIR=./static` - relative path to the directory which contains custom static files to be served from the root - must contain a subdirectory for `admin` and each store view.
-- `BASE_URL=https://frontend.example.com/` (overrides `HOST_NAME` and `HOST_PORT`)
-- `ADMIN_URL=https://backend.exmaple.com/` (overrides `ADMIN_HOST_NAME` and `ADMIN_HOST_PORT`)
-
-**Backups, intrusion protection and other security features are not provided and are left up to you! This is simply a
-web server configuration that adds an easy to configure and maintain SSL termination.**
-
-### Adding more store views
-
-1. Create your new website and/or store codes in OpenMage.
-2. Create new root static asset directories in your static asset directory such as `static/store1`, `static/store2`, etc...
-3. Edit `Caddyfile` to map your domain name to the appropriate `runcode` and `runtype`.
-4. Configure the URLs in the System > Configuration.
-5. Set up your DNS and relaunch Caddy (`docker compose restart caddy`).
-
-Mapping paths to different stores can be done using additional `reverse_proxy` declarations. See `@customfrontend` as an example.
+Please visit the [official documentation](https://docs.openmage.org/developers/tools/oneline/) for more information.

dev/openmage/docker-compose-production.yml

@@ -1,5 +1,3 @@
-version: "3.7"
-
 services:
   php-fpm:
     image: ghcr.io/colinmollenhour/docker-openmage:8.2-fpm

dev/openmage/docker-compose.yml

@@ -1,12 +1,9 @@
-version: "3.7"
-
 services:
   php-fpm:
     image: ghcr.io/colinmollenhour/docker-openmage:8.2-fpm
     volumes:
       - ../..:/var/www/html
     environment:
-      - ENABLE_SENDMAIL=${ENABLE_SENDMAIL:-false}
       - XDEBUG_CONFIG=${XDEBUG_CONFIG:-client_host=host.docker.internal mode=debug force_display_errors=1 start_with_request=yes}
       - MAGE_IS_DEVELOPER_MODE=${MAGE_IS_DEVELOPER_MODE:-1}
       - PM_MAX_CHILDREN=${PM_MAX_CHILDREN:-5}

dev/openmage/install.sh

@@ -62,14 +62,52 @@ $dc run --rm --no-deps cli chmod -R g+ws media var/cache var/log var/locks var/s
 
 echo "Starting services..."
 $dc up -d mysql redis php-fpm
-sleep 4
-for i in $(seq 1 20); do
+
+echo "Installing Composer dependencies..."
+$dc run --rm -u "$(id -u):$(id -g)" cli composer install --no-progress
+
+for i in $(seq 1 30); do
   sleep 1
   $dc exec mysql mysql -e 'show databases;' 2>/dev/null | grep -qF "$MYSQL_DATABASE" && break
+  echo "Waiting for MySQL to be ready..."
 done
 
-echo "Installing Composer dependencies..."
-$dc run --rm -u "$(id -u):$(id -g)" cli composer install --no-progress
+if [[ -n "${SAMPLE_DATA:-}" ]]; then
+  echo "Installing Sample Data..."
+
+  SAMPLE_DATA_KEEP_FLAG="${SAMPLE_DATA_KEEP_FLAG:-0}"
+  SAMPLE_DATA_URL=https://github.com/Vinai/compressed-magento-sample-data/raw/master/compressed-magento-sample-data-1.9.2.4.tgz
+  SAMPLE_DATA_DIRECTORY="${SRC_DIR}/var/sample_data"
+  SAMPLE_DATA_FILE=sample_data.tgz
+
+  if [[ ! -d "${SAMPLE_DATA_DIRECTORY}" ]]; then
+    mkdir -p "${SAMPLE_DATA_DIRECTORY}"
+  fi
+
+  if [[ ! -f "${SAMPLE_DATA_DIRECTORY}/${SAMPLE_DATA_FILE}" ]]; then
+    echo "Downloading Sample Data..."
+    wget "${SAMPLE_DATA_URL}" -O "${SAMPLE_DATA_DIRECTORY}/${SAMPLE_DATA_FILE}"
+  fi
+
+  echo "Uncompressing Sample Data..."
+  tar xf "${SAMPLE_DATA_DIRECTORY}/${SAMPLE_DATA_FILE}" -C "${SAMPLE_DATA_DIRECTORY}"
+
+  echo "Copying Sample Data into the OpenMage directory..."
+  cp -r "${SAMPLE_DATA_DIRECTORY}"/magento-sample-data-1.9.2.4/media/* "${SRC_DIR}/media/"
+  cp -r "${SAMPLE_DATA_DIRECTORY}"/magento-sample-data-1.9.2.4/skin/* "${SRC_DIR}/skin/"
+
+  echo "Importing Sample Data into the database..."
+  $dc exec -T mysql mysql ${MYSQL_DATABASE} < "${SAMPLE_DATA_DIRECTORY}"/magento-sample-data-1.9.2.4/magento_sample_data_for_1.9.2.4.sql
+
+  # remove sample data
+  if [[ ${SAMPLE_DATA_KEEP_FLAG} -eq 1 ]]; then
+    echo "Removing uncompressed files..."
+    rm -rf "${SAMPLE_DATA_DIRECTORY}/magento-sample-data-1.9.2.4/"
+  else
+    echo "Removing sample data..."
+    rm -rf "${SAMPLE_DATA_DIRECTORY}"
+  fi
+fi
 
 echo "Installing OpenMage LTS..."
 $dc run --rm cli php install.php \
@@ -86,6 +124,7 @@ $dc run --rm cli php install.php \
   --use_secure "$([[ $BASE_URL == https* ]] && echo yes || echo no)" \
   --secure_base_url "$BASE_URL" \
   --use_secure_admin "$([[ $ADMIN_URL == https* ]] && echo yes || echo no)" \
+  --enable_charts 'yes' \
   --skip_url_validation \
   --admin_firstname "${ADMIN_FIRSTNAME:-OpenMage}"  \
   --admin_lastname "${ADMIN_LASTNAME:-User}" \
@@ -95,6 +134,7 @@ $dc run --rm cli php install.php \
 
 # Update URL config to split frontend/admin
 $dc exec mysql mysql -e "
+DELETE FROM core_config_data WHERE path IN ('admin/url/use_custom', 'web/unsecure/base_url', 'web/secure/base_url');
 INSERT INTO core_config_data (scope, scope_id, path, value) VALUES
 ('default',0,'admin/url/use_custom','1'),
 ('stores',0,'web/unsecure/base_url','$ADMIN_URL'),
@@ -109,7 +149,7 @@ if command -v curl >/dev/null 2>&1; then
     sleep 1
     curl --silent --fail ${BASE_URL} >/dev/null && break
   done
-  curl --silent --show-error --fail ${BASE_URL} || true
+  curl --silent --show-error --fail ${BASE_URL} -o /dev/null || echo "Frontend test failed: ${BASE_URL}"
 fi
 
 echo ""

docs/content/developers/tools/ddev.md

@@ -5,7 +5,12 @@ tags:
 
 # DDEV
 
-See: https://ddev.com
+[DDEV](https://ddev.com) is a powerful tool to set up and manage local PHP development environments.
+It is a Docker-based wrapper that provides many useful features for developers out of the box.
+
+!!! info
+    If you prefer a simpler development environment with no dependencies aside from Docker, see the
+    [Docker Compose](/developers/tools/oneline) guide instead.
 
 !!! info "Test Environment for OpenMage in Windows 10 Based on DDEV"