Эксперимент с Modx Extra + Docker

Решил попробовать создать сборку для локальной разработки при условии, что через год, два, три я смогу развернуть его из Git и продолжить работу, как и три года назад, без головной боли, что у меня что-то не запускается (за исключением самого Docker)))))).

В чем соль

Разработчик, спустя какое-то время после публикации в общий доступ своих шедевров, приходит к пониманию, что его нужно поддерживать. Поддерживать это значит иметь постоянную среду, которая заточена исключительно под его дополнение.

Как это возможно сделать? Варианты:

• содержать свой сервер, на котором работает твое дополнение;
• иметь где-то какие-то бэкапы, чтобы из них развернуть свое дополнение;
• локально держать свою копию с дополнением;
• устанавливать заново свое дополнение, когда требуется доработка;
• и т.д.

Все это приводит к тому, что разработчик обязан содержать какой-то мануал, как ему через год развернуть дополнение и внести в него изменения.

Решение

Мой подход всегда был таким: 1 сайт, одно дополнение. Иначе конфликты с другими дополнениями приведут к поломке и неадекватности поведения во время разработки.

Из этого родилась идея попробовать собрать образ Docker с MODX + Gitify + modExtra(в моем исполнении).
и кажется, что-то получилось.

Шаблон на GitHub https://github.com/webnitros/modx-extra-docker.

Разработка велась на Mac os, и тут все просто:

git clone https://github.com/webnitros/modx-extra-docker.git
cp .env.example .env
make run-app

Сайт сразу будет доступен по адресу:

http://127.0.0.1:9001/manager/

На linux скорей всего то же запуститься (но не факт). C linux отдельная история с его зверскими правами доступа на файл и что сборка должна запускаться под тем же пользователем что и в докере (в мое образе это user www-data)

Windows — должен поддерживать linux, в общем я так и не осилил docker на Windows по этому хз да же как там запустить

Дополнительная информация в README.md: github.com/webnitros/modx-extra-docker/blob/master/README.md

Выкладываю на пробу в общий доступ.

Где же MODX?

В репозитории вы не увидите обычной структуры MODX. Все файлы MODX специально находятся в Docker-образе, чтобы не приходилось постоянно таскать его за собой.
Директория в контейнере /var/www/html/. В контейнер можно попасть через команду

make app

Если нужно заменить какой-то файл или целую папку, то это можно сделать с помощью volume в файле docker-compose.yml.

Для подсветки кода modx,

1. Скачиваем modx;
2. Распаковываем в удобную директорию;
3. Подключаем в PhpStorm External Librarie, как на скриншоте ниже;

.

Структура файлов Volume

Работать с файлами дополнения нужно будет из одной директории

Extras/myapp/assets/components/myapp
Extras/myapp/core/components/myapp

Вся структура volumes

volumes:
    - "./core/components:/var/www/html/core/components"
    - "./core/elements:/var/www/html/core/elements"
    - "./public/assets:/var/www/html/public/assets"
    - "./Extras:/var/www/html/Extras"
    - "./target:/var/www/html/target"
    - "./.gitify:/var/www/html/.gitify"
    - "./.env:/var/www/html/.env"
    - './_backup:/var/www/html/_backup'
    # Package
    - "./Extras/${PACKAGE_NAME}/core/components/${PACKAGE_NAME}:/var/www/html/core/components/${PACKAGE_NAME}:ro"
    - "./Extras/${PACKAGE_NAME}/assets/components/${PACKAGE_NAME}:/var/www/html/public/assets/components/${PACKAGE_NAME}:ro"

Обращаю внимание на :ro который указан у директории с дополнением, это чтобы невозможно было файлы удалить из директории components.